Private Skill Distribution API Reference
Use the Private Skill Distribution API to manage the distribution list of a private Alexa skill. A distribution list specifies the accounts that have permission to access the skill.
API endpoint
The endpoint of the Private Skill Distribution API is https://api.amazonalexa.com
.
Authentication
Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA).
Operations
The Private Skill Distribution API includes the following operations.
Operation | HTTP Method and URI |
---|---|
| |
Remove an account from the distribution list of a private skill |
|
List the accounts in the distribution list of a private skill |
|
Add an account to the distribution list of a private skill
Adds an account to the distribution list of the specified private skill. After you successfully add the account to the distribution list, the specified account has permission to access the private skill.
Request
To add an account to the distribution list of a private skill, you make a PUT
request to the /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts/{accountId}
resource.
Request header example
PUT /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts/{accountId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request header parameters
Parameter | Description | Type | Required |
---|---|---|---|
|
Skill ID of the private skill to which to add the account to the distribution list. |
String |
Yes |
|
Stage of the private skill. Valid values: |
String |
Yes |
|
Amazon Resource Name (ARN) for an AWS account that you want to grant access to the private skill. When you provide this value, use the exact ARN format: |
String |
Yes |
|
String |
Yes |
Request body example
The request has no body.
Request parameters
The request has no body.
Response
A successful response returns HTTP 204.
Response body example
The response has no body.
Response body parameters
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Account added to the distribution list for the private skill. |
|
Server can't process the request due to a client error. |
|
Authorization token is invalid, expired, or doesn't have access to the resource. |
|
The requested operation isn't allowed. |
|
The requested resource isn't found. |
|
You exceeded the permitted rate limit (specified number of requests per unit of time). |
|
Server has encountered an error. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
Remove an account from the distribution list of a private skill
Removes an account from the distribution list of the specified private skill.
Request
To remove an account from the distribution list, you make a DELETE
request to the /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts/{accountId}
resource.
Request header example
DELETE /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts/{accountId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request header parameters
Parameter | Description | Type | Required |
---|---|---|---|
|
Skill ID of the private skill from which to delete the account from the distribution list. |
String |
Yes |
|
Stage of the private skill. Valid values: |
String |
Yes |
|
Amazon Resource Name (ARN) for the AWS account to delete from the distribution list of the private skill. When you provide this value, use the exact ARN format: |
String |
Yes |
|
String |
Yes |
Request body example
The request has no body.
Request body parameters
The request has no body.
Response
A successful response returns HTTP 204.
Response body example
The response has no body.
Response body parameters
The response has no body.
HTTP status codes
Status | Description |
---|---|
|
Account deleted from the distribution list for the private skill. |
|
Server can't process the request due to a client error. |
|
Authorization token is invalid, expired, or doesn't have access to the resource. |
|
The requested operation isn't allowed. |
|
The requested resource isn't found. |
|
You exceeded the permitted rate limit (specified number of requests per unit of time). |
|
Server has encountered an error. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |
List the accounts in the distribution list of a private skill
List the accounts in the distribution list of a private skill.
Request
To list distribution accounts, you make a GET request to the /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts
resource.
Request header example
GET /v1/skills/{skillId}/stages/{stage}/privateDistributionAccounts
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Request header parameters
Parameter | Description | Type | Required |
---|---|---|---|
|
Skill ID of the private skill for which to list the distribution accounts. |
String |
Yes |
|
Stage of the private skill. Valid values: |
String |
Yes |
|
Token that you use to get more items in the list, after you receive a response with truncated results. Set this value to the value of |
String |
No |
|
Maximum number of items to return in the response. |
String |
No |
|
String |
Yes |
Request body example
The request body has no body.
Request body parameters
The request body has no body.
Response
A successful response returns HTTP 200, along with a list of distribution accounts.
Response body example
The following example shows a response.
{
"privateDistributionAccounts": [
{
"principal": "111122223333",
"acceptStatus": "ACCEPTED"
},
{
"principal": "444455556666",
"acceptStatus": "PENDING"
}
],
"nextToken": "12345"
}
Response body parameters
Parameter | Description | Type |
---|---|---|
|
List of accounts on the distribution list of the private skill. |
Array |
|
Account that is on the distribution list of the private skill. |
String |
|
Enterprise IT administrator's action on the private skill distribution. |
String |
|
Value to use for the |
String |
HTTP status codes
Status | Description |
---|---|
|
Response body contains a list of distribution accounts associated with the private skill. |
|
Server can't process the request due to a client error. |
|
Authorization token is invalid, expired, or doesn't have access to the resource. |
|
The requested operation isn't allowed. |
|
The requested resource isn't found. |
|
You exceeded the permitted rate limit (specified number of requests per unit of time). |
|
Server has encountered an error. |
|
Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request. |