翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# エッジデバイスで使用する AWS IoT SiteWise エッジ専用 APIs
<a name="edge-local-apis"></a>

エッジで使用できる AWS IoT SiteWise APIs に加えて、エッジ固有の API もあります。以下では、そうしたエッジ特有の API を説明します。

## Authenticate
<a name="edge-local-apis-authenticate"></a>

SiteWise Edge ゲートウェイから認証情報を取得します。LDAP または Linux ユーザープールを使用してローカルユーザーを追加するか、システムに接続する必要があります。ユーザーの追加の詳細については、「[LDAP](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app)」または「[Linux ユーザープール](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app)」を参照してください。

### リクエストの構文
<a name="authenticate-request-syntax"></a>

```
POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}
```

### URI リクエストのパラメータ
<a name="authenticate-request-parameters"></a>

リクエストでは URI パラメータを使用しません。

### リクエストボディ
<a name="authenticate-request-body"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

**username**  
リクエスト呼び出しの検証に使用するユーザー名。  
タイプ: 文字列  
必須: はい

**password**  
認証情報をリクエストしているユーザーのパスワード。  
タイプ: 文字列  
必須: はい

**authMechanism**  
ホストでこのユーザーを検証するための認証方法。  
タイプ: 文字列  
有効な値: `ldap`、`linux`、`winnt`  
必須: はい

### レスポンスの構文
<a name="authenticate-response-syntax"></a>

```
HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}
```

### レスポンス要素
<a name="authenticate-response-elements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

以下のデータが JSON 形式で返されます。

**accessKeyId**  
仮のセキュリティ認証情報を識別するアクセスキー ID。  
長さ制限: 最小長は 16 です。最大長は 128 です。  
パターン: `[\w]*`

**secretAccessKey**  
リクエストへの署名に使用できるシークレットアクセスキー。  
タイプ: 文字列

**sessionToken**  
仮の認証情報を使用するために、ユーザーがサービス API に渡す必要があるトークン。  
タイプ: 文字列

**リージョン**  
API コールのターゲットにするリージョン。  
型: 定数 - `edge`

### エラー
<a name="authenticate-errors"></a>

**IllegalArgumentException**  
提供された本文ドキュメントの形式に誤りがあるため、リクエストが拒否されました。エラーメッセージは、それぞれのエラーの説明です。  
HTTP ステータスコード: 400

**AccessDeniedException**  
ユーザーには、現在の ID プロバイダーに基づく有効な認証情報がありません。このエラーメッセージは認証メカニズムの説明です。  
HTTP ステータスコード: 403

**TooManyRequestsException**  
リクエストが認証試行回数の上限に達しました。エラーメッセージには、新しい認証試行が行われるまで待機する時間が含まれています。  
HTTP ステータスコード: 429