エンドポイントWi-Fi管理REST APIリファレンス

エンドポイントWi-Fi管理REST APIリファレンス

エンドポイントWi-Fi管理REST APIは、Wi-Fiネットワークの設定や、エンドポイントへのWi-Fiネットワークの割り当てに使用します。Alexa Smart Properties（ASP）では、エンドポイントは、Amazon EchoデバイスやAlexaコネクテッド照明など、ASPのゲストや居住者が操作できるAlexaコネクテッドデバイスまたはコンポーネントを表します。通常、施設所有者はデフォルトのWi-Fiネットワークでデバイスを設定した後、これらの操作を使用して追加のWi-Fiネットワークをデバイスに割り当てます。Wi-Fi Protected Access 2（WPA2）Enterprise Wi-Fiの場合、デバイスを設定した後、WPA2拡張認証プロトコル（EAP）ネットワークをデバイスに関連付けます。

Wi-Fiネットワーク設定をエンドポイントに割り当てるには、次の順序でこれらの操作を呼び出します。

  1. Wi-Fi設定をアカウントのAmazon Wi-Fiロッカーに保存します。
  2. 保存したWi-Fi設定の1つまたは複数をエンドポイントに割り当てます。
    この手順で、エンドポイントがオンラインであることを確認します。
  3. （任意）設定割り当てのステータスを取得します。

Amazonビジネスアカウントで所有されているデバイスの設定を表示および変更する場合は、エンドポイントWi-Fi管理APIとエンドポイントREST APIを併せて使用します。

APIエンドポイント

組織が所在する国に応じて、リクエストヘッダーのHostパラメーターを、以下のいずれかのAPIエンドポイントに設定してください。

国 エンドポイント

カナダ、米国

https://api.amazonalexa.com

ドイツ、スペイン、フランス、イタリア、英国

https://api.eu.amazonalexa.com

日本

https://api.fe.amazonalexa.com

認証

すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。詳細については、APIアクセスを管理するを参照してください。

エンドポイントWi-Fi管理APIを使用するには、以下のスコープのLWAトークンをリクエストします。

  • credential_locker::wifi_management
  • alexa::enterprise:management

操作

エンドポイント機能APIには、以下の操作が用意されています。

操作 HTTPメソッドとURI

Wi-Fi設定を削除する

POST /v2/endpoints/{endpointId}/features/connectivity/forgetWifiConfigurations

Wi-Fiのインストールステータスを取得する

GET /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId}

Wi-Fi設定をリスト表示する

GET /v2/endpoints/{endpointId}/features/connectivity/wifiConfigurations

Wi-Fi設定を保存する

POST /credentiallocker/v2/saveWifiConfigurations

Wi-Fi設定を設定する

POST /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations

Wi-Fi設定を削除する

指定したエンドポイントからWi-Fi設定を削除します。Wi-Fi設定を削除するには、デバイスがオンラインであり、エンドポイントに2つ以上のWi-Fiネットワーク設定が割り当てられている必要があります。エンドポイントに割り当てられているWi-Fi設定が1つである場合、指定したWi-Fi設定をエンドポイントから削除できません。

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

Healthcare Hospitality Senior Living Core

なし

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

なし

リクエスト

設定を削除するには、/v2/endpoints/{endpointId}/features/connectivity/forgetWifiConfigurationsリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

POST /v2/endpoints/{endpointId}/features/connectivity/forgetWifiConfigurations
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}

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

パラメーター 位置 説明 型 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier（ACI）形式で表します。

文字列

◯

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

◯

リクエスト本文の例

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

{
    "payload": {
        "wifiConfigurations": [{
            "ssid": "wifi-name.1",
            "keyManagement": "WPAPSK"
        }]
    }
}

リクエスト本文のプロパティ

プロパティ 説明 型 必須

payload

削除するWi-Fi設定を含みます。

オブジェクト

◯

payload.wifiConfigurations

Wi-Fi設定のリスト。
削除する1つの設定を含みます。

オブジェクトの配列

◯

payload.wifiConfigurations[].ssid

Wi-Fiネットワーク名。

文字列

◯

payload.wifiConfigurations[].keyManagement

Wi-Fi設定のセキュリティタイプ。
有効な値は次のとおりです。

  • WPAPSK – Wi-Fi Protected Access（WPA2）Pre-Shared Key。
  • WPA2_EAP – WPA2拡張認証プロトコル（EAP）。
  • OPEN – セキュリティを使用しないWi-Fiネットワーク。

文字列

◯

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

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

応答本文のプロパティ

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

HTTPステータスコード

ステータス 説明

200 OK

指定したWi-Fi設定がデバイスから正常に削除されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ALTERNATE_NETWORK_CONNECTION_FAILURE – エンドポイントは指定したWi-Fi設定に接続されていますが、デバイスに存在する代替設定の接続に失敗しました。
  • BAD_REQUEST – 不正なリクエストです。
  • ENDPOINT_NOT_SUPPORTED – エンドポイントがサポートされていません。
  • NO_ALTERNATE_NETWORK – エンドポイントは指定したWi-Fi設定に接続されていますが、デバイスに代替ネットワーク設定がありません。
  • TOO_MANY_CONFIGURATIONS – リクエストに含めるWi-Fi設定は厳密に1つでなければなりません。

401 Unauthorized

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

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • NO_SUCH_ENDPOINT – エンドポイントが見つかりません。

429 Too Many Requests

許可されたレート制限（単位時間あたりのリクエスト数として指定された値）を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

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

504 Gateway Timeout

エンドポイントから応答がありません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_UNREACHABLE – エンドポイントがオフラインか到達不能です。

Wi-Fiのインストールステータスを取得する

指定されたエンドポイントでの前回のWi-Fi設定を設定する操作のステータスを取得します。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

米国

リクエスト

ステータスを取得するには、/v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations/submittedOperationsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations/submittedOperations/{operationId}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

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

パラメーター 位置 説明 型 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というACI形式で表します。

文字列

◯

operationId

パス

Wi-Fi設定を設定する操作で返された一意のsubmittedOperationId。

文字列

◯

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

◯

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKと共に、Wi-Fiの設定ステータスが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

{
    "status": {
        "value": "IN_PROGRESS"
    }
}

応答本文のプロパティ

プロパティ 説明 型

status

指定されたエンドポイントに対してリクエストされたWi-Fi設定のインストールステータスを識別します。

オブジェクト

status.value

操作ステータスの値。
有効な値は SUCCESS、FAILURE、TIMEOUT、IN_PROGRESSです。

文字列

HTTPステータスコード

ステータス 説明

200 OK

Wi-Fi設定の現在のインストールステータスが応答本文に含まれます。

300 Multiple Choices

エンドポイントIDが変更されましたが、基になるリソースは変わりません。応答本文には、新しいエンドポイントIDのURI参照が含まれます。たとえば、/v2/endpoints/{newId}のようになります。

301 Moved Permanently

エンドポイントIDが変更されましたが、基になるリソースは変わりません。応答本文には、新しいエンドポイントIDのURI参照が含まれます。たとえば、/v2/endpoints/{newId}のようになります。

303 See Other

エンドポイントが別のエンドポイントと結合されたため、基になるリソースが変更されました。応答本文には、新しいエンドポイントIDのURI参照が含まれます。たとえば、/v2/endpoints/{newId}のようになります。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

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

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • NO_SUCH_ENDPOINT – エンドポイントが見つかりません。

429 Too Many Requests

許可されたレート制限（単位時間あたりのリクエスト数として指定された値）を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

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

504 Gateway Timeout

エンドポイントから応答がありません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_UNREACHABLE – エンドポイントがオフラインか到達不能です。

Wi-Fi設定をリスト表示する

指定されたエンドポイントに割り当てられたWi-Fi設定のリストを取得します。Wi-Fi設定のリストを表示するには、デバイスがオンラインである必要があります。

リクエスト

設定をリストするには、/v2/endpoints/{endpointId}/features/connectivity/wifiConfigurationsリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v2/endpoints/{endpointId}/features/connectivity/wifiConfigurations
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}

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

パラメーター 位置 説明 型 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier（ACI）形式で表します。

文字列

◯

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

◯

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKと共に、Wi-Fi設定のリストが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

{
    "wifiConfigurations": [{
            "connectivityStatus": "CONNECTED",
            "keyManagement": "OPEN",
            "ssid": "wifi-name.1"
        },
        {
            "connectivityStatus": "NOT_CONNECTED",
            "keyManagement": "WPA2_PSK",
            "ssid": "wifi-name.2"
        }
    ]
}

応答本文のプロパティ

プロパティ 説明 型

wifiConfigurations

エンドポイントに保存されたWi-Fi設定のリスト。

オブジェクトの配列

wifiConfigurations[].connectivityStatus

このWi-Fiネットワークへのエンドポイントの接続ステータスを含みます。
有効な値は CONNECTED、NOT_CONNECTED。

文字列

wifiConfigurations[].keyManagement

Wi-Fi設定のセキュリティタイプ。
有効な値は次のとおりです。

  • WPAPSK – Wi-Fi Protected Access（WPA2）Pre-Shared Key。
  • WPA2_EAP – WPA2拡張認証プロトコル（EAP）。
  • OPEN – セキュリティを使用しないWi-Fiネットワーク。

文字列

wifiConfigurations[].ssid

Wi-Fiネットワーク名。

文字列

HTTPステータスコード

ステータス 説明

200 OK

応答本文には、指定したエンドポイントに関連付けられたWi-Fi設定のリストが含まれます。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

401 Unauthorized

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

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • NO_SUCH_ENDPOINT – エンドポイントが見つかりません。

429 Too Many Requests

許可されたレート制限（単位時間あたりのリクエスト数として指定された値）を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

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

504 Gateway Timeout

エンドポイントから応答がありません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_UNREACHABLE – エンドポイントがオフラインか到達不能です。

Wi-Fi設定を保存する

Wi-Fi設定をアカウントのAmazon Wi-Fiロッカーに保存します。後で、Wi-Fi設定を設定する操作で、これらの設定の1つまたは複数をエンドポイントに割り当てます。サービスセット識別子（SSID）が非公開であるネットワークを使用する場合は、Wi-Fi設定を保存する前に、非公開のSSIDを使用するネットワークを設定します。

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

Healthcare Hospitality Senior Living Core

米国

米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本

米国、カナダ、ドイツ、スペイン、フランス、イタリア、英国、日本

米国

リクエスト

Wi-Fi設定を保存するには、/credentiallocker/v2/saveWifiConfigurationsリソースに対してPOSTリクエストを実行します。

APIエンドポイント

組織が所在する国に応じて、リクエストヘッダーのHostパラメーターを、以下のいずれかのAPIエンドポイントに設定してください。

国 エンドポイント

カナダ、米国

https://credential-locker-service.amazon.com

ドイツ、スペイン、フランス、イタリア、英国

https://credential-locker-service.amazon.eu

日本

https://credential-locker-service.amazon.jp

リクエストパスとリクエストヘッダーの例

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

POST /credentiallocker/v2/saveWifiConfigurations
Host: credential-locker-service.amazon.com
x-amz-access-token: {access token}
Content-Type: application/json
Authorization: Bearer {access token}

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

パラメーター 位置 説明 型 必須

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

◯

リクエスト本文の例

以下は、ネットワークアクセスにWi-Fi Protected Access 2（WPA2）Pre-Shared Key（WPAPSK）を使用するWi-Fi設定の例です。

以下は、ネットワークアクセスにWPA2_EAPとエンタープライズネットワークアクセスの証明書を使用するWi-Fi設定の例です。

リクエスト本文のプロパティ

フィールド 説明 型 必須

wifiConfigurations

保存するWi-Fi設定のリスト。

オブジェクトの配列

◯

wifiConfigurations[].ssid

Wi-Fiネットワーク名。
次のように名前を二重引用符で囲みます。"\"ssid\""

文字列

◯

wifiConfigurations[].keyManagement

Wi-Fi設定のセキュリティタイプ。
有効な値は次のとおりです。

  • WPAPSK – Wi-Fi Protected Access（WPA2）Pre-Shared Key。
  • WPA2_EAP – WPA2拡張認証プロトコル（EAP）。
  • OPEN – セキュリティを使用しないWi-Fiネットワーク。

文字列

◯

wifiConfigurations[].credentialConfiguration

Wi-Fiネットワークの認証情報。

CredentialConfigurationオブジェクト

◯

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

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

応答本文のプロパティ

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

HTTPステータスコード

ステータス 説明

200 OK

Wi-Fi設定が正常に保存されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • CERTIFICATE_MISMATCH – 指定したCA証明書が、その証明書に署名した証明書で指定されている条件に準拠していません。

401 Unauthorized

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

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • NO_SUCH_ENDPOINT – エンドポイントが見つかりません。

429 Too Many Requests

許可されたレート制限（単位時間あたりのリクエスト数として指定された値）を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

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

504 Gateway Timeout

エンドポイントから応答がありません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_UNREACHABLE – エンドポイントがオフラインか到達不能です。

Wi-Fi設定を設定する

保存されているWi-Fi設定を指定されたエンドポイントに関連付けます。Wi-Fi設定をデバイスに保存するには、エンドポイントがオンラインである必要があります。一度に1つずつ、最大32のWi-Fi設定を1つのエンドポイントに関連付けることができます。

通常の操作では、エンドポイントはデバイスに関連付けられたWi-Fiネットワークのいずれかに接続を試行します。あるWi-Fiネットワークが利用できなくなると、デバイスはオフラインになることがありますが、最終的には利用可能なWi-Fiネットワークに接続されます。

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

Healthcare Hospitality Senior Living Core

なし

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

米国、カナダ、英国、ドイツ、フランス、イタリア、スペイン、日本

なし

リクエスト

Wi-Fi設定を設定するには、/v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurationsリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

POST /v2/endpoints/{endpointId}/features/connectivity/addOrUpdateWifiConfigurations
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

パラメーター 位置 説明 型 必須

endpointId

パス

このエンドポイントの一意のID。ユーザーデバイスごとにAmazonから割り当てられています。
amzn1.alexa.endpoint.{id}というAmazon Common Identifier（ACI）形式で表します。

文字列

◯

access token

ヘッダー

ユーザーのアクセストークン。
LWAトークンに設定します。

文字列

◯

リクエスト本文の例

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

{
    "payload": {
        "wifiConfigurations": [{
            "ssid": "\"wifi-name.1\"",
            "keyManagement": "WPAPSK"
        }]
    }
}

リクエスト本文のプロパティ

フィールド 説明 型 必須

payload

Wi-Fi設定の定義を含みます。

オブジェクト

◯

payload.wifiConfigurations

指定されたエンドポイントで追加または更新するWi-Fi設定のリスト。
Wi-Fi設定を保存する操作で定義された設定のみを含めます。
配列には最大1つの設定を含めます。
エンドポイントごとの設定の最大数は 32です。

オブジェクトの配列

◯

payload.wifiConfigurations[].ssid

Wi-Fiネットワーク名。
次のように名前を二重引用符で囲みます。"\"ssid\""

文字列

◯

payload.wifiConfigurations[].keyManagement

Wi-Fi設定のセキュリティタイプ。
有効な値は次のとおりです。

  • WPAPSK – Wi-Fi Protected Access（WPA2）Pre-Shared Key。
  • WPA2_EAP – WPA2拡張認証プロトコル（EAP）。
  • OPEN – セキュリティを使用しないWi-Fiネットワーク。

文字列

◯

応答

正常に完了すると、HTTP 200 OKと共に、Wi-Fi設定のインストールステータスを取得するための識別子が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にErrorオブジェクトが追加されます。

応答本文の例

{
    "submittedOperationId": "operationId.1"
}

応答本文のプロパティ

プロパティ 説明 型

submittedOperationId

エンドポイントの設定を設定するリクエストを識別します。
Wi-Fiのインストールステータスを取得する操作でこの値を使用します。

文字列

HTTPステータスコード

ステータス 説明

202 Accepted

指定されたエンドポイントで正常に追加または更新されたWi-Fi設定。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_NOT_SUPPORTED – 指定されたエンドポイントでは、Wi-Fi設定をリモートで追加または更新する操作はサポートされていません。
  • INVALID_CA_CERTIFICATE – 認証局の証明書が、発行される証明書の有効期限の前に期限切れになるか既に期限切れになっているため、このリクエストの証明書を発行できません。
  • INVALID_CA_STATUS – このSSIDにリンクされた認証局がアクティブ状態になっていないため、このリクエストの証明書を発行できません。
  • INVALID_CONFIGURATION – リクエストに含まれているWi-Fi設定の形式が無効です。
  • TOO_MANY_CONFIGURATIONS – リクエストに含めるWi-Fi設定は厳密に1つでなければなりません。

401 Unauthorized

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

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。

404 Not Found

リクエストされたリソースが見つかりません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • NO_SUCH_ENDPOINT – エンドポイントが見つかりません。

429 Too Many Requests

許可されたレート制限（単位時間あたりのリクエスト数として指定された値）を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

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

504 Gateway Timeout

エンドポイントから応答がありません。

応答には、以下のいずれかのエラータイプとメッセージが含まれる場合があります。

  • ENDPOINT_UNREACHABLE – エンドポイントがオフラインか到達不能です。

オブジェクトの定義

エンドポイントWi-Fi管理APIでは、以下のオブジェクトが定義されています。

CertificateAuthorityオブジェクト

CertificateAuthorityオブジェクトは、デジタル証明書の作成および検証を行う認証局組織を識別します。

プロパティ 説明 型

providerName

認証局組織を識別します。

文字列

id

プロバイダーシステム内の認証局リソースを識別します。

文字列

CredentialConfigurationオブジェクト

CredentialConfigurationオブジェクトは、Wi-Fiネットワークの設定を定義します。

プロパティ 説明 型

privateSharedKey

（任意）Wi-Fiネットワークアクセス用のパスワード。二重引用符で囲みます。WPAPSKのキー管理に必要です。OPENネットワークの場合は、nullに設定します。

文字列

eapAuthenticationMethod

（任意）Wi-Fiネットワークアクセスに使用する拡張認証プロトコル（EAP）を識別します。WPA2_EAPのキー管理に必要です。
有効な値は EAP-TLSです。

文字列

certificateAuthority

（任意）認証局を識別します。
WPA2_EAPのキー管理に必要です。

CertificateAuthorityオブジェクト

authenticationServerCertificates

（任意）信頼できるネットワークを識別するために使用される証明書のリスト。
WPA2_EAPのキー管理に必要です。

文字列の配列

Errorオブジェクト

Errorオブジェクトは、エラーが発生したときに応答に含まれるエラーのタイプとメッセージを定義します。

以下は、エラーコードとメッセージを含む応答本文の例です。

{
    "type": "BAD_REQUEST",
    "message": "The request is malformed or is missing any required parameters."
}
プロパティ 説明 型

type

発生したエラーのタイプ。
具体的なエラータイプについては、各操作のHTTPステータスコードの表を参照してください。

文字列

message

エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーメッセージの内容に依存するビジネスロジックを構築しないようにする必要があります。

文字列

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

最終更新日: 2024 年 12 月 13 日