翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
API リクエストを作成する
Amazon Verified Permissions のクエリリクエストは、 POSTメソッドを使用する HTTP または HTTPS リクエストです。
Verified Permissions エンドポイント
エンドポイントは、ウェブサービスのエントリポイントとして機能する URL です。レイテンシーを減らすリクエストを行うときに、適切な AWS リージョン エンドポイントを選択できます。Verified Permissions で使用されるエンドポイントの詳細については、の「Amazon Verified Permissions」を参照してくださいAmazon Web Services 全般のリファレンス。
リクエストパラメータ
Amazon Verified Permissions は JSON ベースのプロトコルを使用します。HTTP リクエストの本文でリクエストパラメータを JSON として渡します。リストは JSON 配列として表されます。詳細については、Amazon Verified Permissions API リファレンスの「共通パラメータ」を参照してください。
リクエスト識別子
すべてのレスポンスで、 は HTTP レスポンスヘッダーを介してリクエスト ID x-amzn-RequestId AWS を返します。この文字列は、追跡情報を提供するために が AWS 割り当てる一意の識別子です。リクエスト ID はすべてのレスポンスに含まれていますが、読みやすさを向上させ、冗長性を低減するために、個々の API ドキュメントページには記載されていません。
クエリ API 認証
HTTPS 経由でクエリリクエストを送信します。すべてのクエリリクエストに署名を含める必要があります。署名の作成と含めの詳細については、のAWS 「 API リクエストの署名」を参照してくださいAmazon Web Services 全般のリファレンス。
利用可能なライブラリ
AWS は、コマンドラインツールやクエリ API の代わりに言語固有の APIs を使用してアプリケーションを構築するソフトウェア開発者向けに、ライブラリ、サンプルコード、チュートリアル、その他のリソースを提供します。これらのライブラリには、リクエスト認証、リクエストの再試行、エラー処理などの基本的な関数 (APIs には含まれていません) が用意されているため、簡単に開始できます。Verified Permissions ライブラリとリソースは、次の言語とプラットフォームで使用できます。
すべての言語のライブラリとサンプルコードの詳細については、「サンプルコードとライブラリ」を参照してください。
POST メソッドを使用した API リクエストの実行
AWS SDKs のいずれかを使用しない場合は、 リクエストメソッドを使用して HTTPS 経由で Verified Permissions POSTリクエストを行うことができます。POST メソッドでは、リクエストの ヘッダーに オペレーションを指定し、リクエストの本文に JSON 形式でオペレーションのデータを指定する必要があります。
| ヘッダー名 | ヘッダー値 |
|---|---|
Host |
Amazon Verified Permissions エンドポイント。例: |
X-Amz-Date |
HTTP Date ヘッダーまたは the AWS x-amz-date ヘッダーのいずれかにタイムスタンプを指定する必要があります。一部の HTTP クライアントライブラリでは、日付ヘッダーを設定できません。x-amz-date ヘッダーが存在する場合、システムはリクエスト認証中に Date ヘッダーを無視します。 x-amz-date ヘッダーは ISO 8601 基本形式で指定する必要があります。例: |
Authorization |
リクエストの有効性と信頼性を確保するために が AWS 使用する認可パラメータのセット。このヘッダーの作成の詳細については、の「署名バージョン 4 の署名プロセス」を参照してくださいAmazon Web Services 全般のリファレンス。 |
X-Amz-Target |
実行する Verified Permissions オペレーションを指定します。
たとえば、
|
Content-Type |
入力形式を指定します。次の値を使用します。
|
Accept |
レスポンス形式を指定します。次の値を使用します。
|
Content-Length |
バイト単位のペイロードのサイズ。 |
Content-Encoding |
入力と出力のエンコード形式を指定します。次の値を使用します。
|
以下は、 がUser名前付き AWS アカウント Principalを参照する の指定されたポリシーストア内のすべてのポリシーのリストを返す HTTP リクエストのヘッダーの例ですalice。この例では、読みやすくするために、このAuthorization行はここで単語ラップされています。実際のリクエストにラップしないでください。
POST / HTTP/1.1 Host: verifiedpermissions.us-east-1.amazonaws.com X-Amz-Date: 20230101T200059Z Accept-Encoding: identity Content-Type: application/x-amz-json-1.0 X-Amz-Target: VerifiedPermissions.ListPolicies User-Agent: <UserAgentString> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature> Content-Length: <PayloadSizeBytes> { "PolicyStoreId": "PSExAmPLE222222222", "Filter": { "Principal": { "Id": { "EntityType": "User", "EntityId": "alice" } } } }
