Account Linking Management, v0

This document describes all API operations related to linking Alexa user accounts to other OAuth identity providers. Each request must have an Authorization header whose value should be the access token retrieved from Login with Amazon.

See also: Alexa Skills Kit Command Line Interface (ASK CLI) Overview

Update Account Linking

Request

PUT /v0/skills/{skillId}/accountLinkingClient

{
  "accountLinkingRequest": {
    "type": "AUTH_CODE",
    "authorizationUrl": "string",
    "domains": [
      "string"
    ],
    "clientId": "string",
    "scopes": [
      "string"
    ],
    "accessTokenUrl": "string",
    "clientSecret": "string",
    "accessTokenScheme": "HTTP_BASIC",
    "defaultTokenExpirationInSeconds": integer
  }
}

Parameter Description

Field Description Parameter Type Required?
skillId Unique identifier of skill. Path Yes

Body Description

Contains an accountLinkingRequest object. For details, see Account Linking Schemas.

Response

HTTP/1.1 204 No Content

Read Account Linking Info

Request

GET /v0/skills/{skillId}/accountLinkingClient

Parameter Description

Field Description Parameter Type Required?
skillId Unique identifier of skill. Path Yes

Response

HTTP/1.1 200 OK

{
  "accountLinkingResponse": {
    "clientId": "abc",
    "authorizationUrl": "https://www.example.com/auth_url",
    "accessTokenUrl": "https://www.example.com/accessToken_url",
    "domains": [
      "www.example.com"
    ],
    "scopes": [
      "scope_a",
      "scope_b"
    ],
    "accessTokenScheme": "HTTP_BASIC",
    "type": "AUTH_CODE"
  }
}
Was this page helpful?

Last updated: Mar 30, 2022