ユーザーAPIリファレンス

ユーザーAPIリファレンス

ユーザーAPIを使用すると、ユーザーの表現の作成、削除、リスト取得を行うことができます。

APIエンドポイント

リクエストヘッダーでは、組織が所在する地域に応じて、Hostをhttps://api.amazonalexa.comに設定してください。

認証

すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。

操作

ユーザーAPIには、以下の操作が用意されています。

操作 HTTPメソッドとURI

ユーザーを作成する

POST /v1/auth/users

ユーザーのリストを取得する

GET /v1/auth/users

ユーザーを削除する

DELETE /v1/auth/users/{userId}

ユーザーを作成する

指定した組織にユーザーを作成します。

この操作は以下の国で使用できます。

Healthcare Hospitality Senior Living Core

なし

米国、カナダ

米国、カナダ

米国、カナダ

リクエスト

ユーザーを作成するには、/v1/auth/usersリソースに対してPOSTリクエストを実行します。

リクエストヘッダーの例

クリップボードにコピーされました。

POST /v1/auth/users HTTP/1.1
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストヘッダーのパラメーター

パラメーター 説明 型 必須

access token

LWAトークン。

文字列

◯

リクエスト本文の例

クリップボードにコピーされました。

{
  "organizationId": "amzn1.alexa.org.did.exampleId"
}

リクエスト本文のパラメーター

パラメーター 説明 型 必須

organizationId

ユーザーを追加する組織のID。組織IDはamzn1.alexa.org.did.{id}形式で表します。

文字列

◯

応答

正常に完了すると、HTTP 201が返されます。

応答本文の例

以下は、成功した応答の本文の例です。

クリップボードにコピーされました。

{
  "userId": "amzn1.alexa.org.user.did.ABCGHLLKJKJHGHGHJ",
  "accessToken": "Atza|ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  "refreshToken": "Atzr|ABCDEFGHIJKLMNOPQRSTUVWXYZ"
}

応答本文のパラメーター

パラメーター 説明 型

userId

追加したユーザーのID。

文字列

accessToken

追加したユーザーを表すトークン。このトークンは後続のAPI呼び出しに使用します。

文字列

refreshToken

追加したユーザーを表す更新トークン。このトークンはアクセストークンを更新するために使用します。

文字列

HTTPステータスコード

ステータス 説明

201 OK

ユーザーが正常に作成されました。

400 INVALID_OPERATOR

呼び出し元が指定された組織に含まれていません。

400 INVALID_ORGANIZATION_ID

組織IDが無効です。

401 UNAUTHORIZED

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 FORBIDDEN

操作を実行する権限が呼び出し元にありません。

429 TOO_MANY_REQUESTS

呼び出し元が、許可されたレート制限（単位時間あたりの指定されたリクエスト数）を超過しています。

500 INTERNAL_SERVER_ERROR

サーバーでエラーが発生しました。

503 SERVICE_UNAVAILABLE

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ユーザーのリストを取得する

指定した組織のユーザーのリストを取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Senior Living Core

なし

米国、カナダ

米国、カナダ

米国、カナダ

リクエスト

ユーザーのリストを取得するには、/v1/auth/usersリソースに対してGETリクエストを実行します。

リクエストヘッダーの例

クリップボードにコピーされました。

GET /v1/auth/users?organizationId={organizationId}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストヘッダーのパラメーター

パラメーター 説明 型 必須

access token

LWAトークン。

文字列

◯

organizationId

ユーザーのリストを取得する組織のID。組織IDはamzn1.alexa.org.did.{id}形式で表します。

文字列

◯

maxResults

応答本文で返される結果の最大数。10以下の正の値を指定してください。デフォルト値は10です。詳細については、クエリ結果のページ分割を処理するを参照してください。

数値

✕

nextToken

ページ分割された結果から特定のページを取得するためのトークン。このトークンがない場合、応答には結果の先頭ページが含められます。詳細については、クエリ結果のページ分割を処理するを参照してください。

文字列

✕

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、ユーザーのリストと共にHTTP 200が返されます。

応答本文の例

以下は、成功した応答の本文の例です。

クリップボードにコピーされました。

{
  "results": [
    {
      "userId": "amzn1.alexa.org.user.did.12345EXAMPLE"
    }
  ],
  "paginationContext": {
    "nextToken": null
  }
}

応答本文のパラメーター

パラメーター 説明 型

results[]

クエリへの応答で返されたユーザーのリスト。

配列

results[].userId

取得したユーザーのID。ユーザーIDはamzn1.alexa.org.user.did.{id}形式で表します。

文字列

paginationContext.nextToken

結果がページ分割されており、ほかにもまだある場合に、ほかの結果を取得するためのトークン。

文字列

HTTPステータスコード

ステータス 説明

200 OK

 指定された組織IDのユーザーのリストが正常に取得されました。

400 INVALID_OPERATOR

呼び出し元が指定された組織に含まれていません。

400 INVALID_ORGANIZATION_ID

組織IDが無効です。

400 INVALID_NEXT_TOKEN

ページ分割トークンが無効です。

401 UNAUTHORIZED

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 FORBIDDEN

操作を実行する権限が呼び出し元にありません。

429 TOO_MANY_REQUESTS

ユーザーが、許可されたレート制限（単位時間あたりの指定されたリクエスト数）を超過しています。

500 INTERNAL_SERVER_ERROR

サーバーでエラーが発生しました。

503 SERVICE_UNAVAILABLE

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

ユーザーを削除する

指定したユーザーを削除します。

この操作は以下の国で使用できます。

Healthcare Hospitality Senior Living Core

なし

米国、カナダ

米国、カナダ

米国、カナダ

リクエスト

ユーザーを削除するには、/v1/auth/users/{userId}リソースに対してDELETEリクエストを実行します。

リクエストヘッダーの例

クリップボードにコピーされました。

DELETE /v1/auth/users/{userId} HTTP/1.1
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストヘッダーのパラメーター

パラメーター 説明 型 必須

access token

LWAトークン。

文字列

◯

userId

削除するユーザーのID。ユーザーIDはamzn1.alexa.org.user.did.{id}形式で表します。

文字列

◯

リクエスト本文の例

リクエストの本文はありません。

応答

正常に完了すると、HTTP 204が返されます。

応答本文の例

応答の本文はありません。

HTTPステータスコード

ステータス 説明

204 NO CONTENT

ユーザーが正常に削除されました。

400 INVALID_OPERATOR

呼び出し元が指定された組織に含まれていません。

401 UNAUTHORIZED

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 FORBIDDEN

操作を実行する権限が呼び出し元にありません。

404 NO_SUCH_USER

ユーザーが見つかりません。

429 TOO_MANY_REQUESTS

ユーザーが、許可されたレート制限（単位時間あたりの指定されたリクエスト数）を超過しています。

500 INTERNAL_SERVER_ERROR

サーバーでエラーが発生しました。

SERVICE_UNAVAILABLE

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

このページは役に立ちましたか？

最終更新日: 2024 年 03 月 21 日