翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
生産性向上 AppFabric のための の管理 AppClients
AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。 |
AppFabric for productivity を管理 AppClients して、認証および認証プロセスの運用とメンテナンスをスムーズに行うことができます。
の詳細を取得する AppClient
API AppFabric GetAppClient
オペレーションを使用して、 AppClient ステータスの確認など AppClient、 の詳細を表示します。詳細については、「GetAppClient」を参照してください。
の詳細を取得するには AppClient、少なくとも IAM "appfabric:GetAppClient"
ポリシーのアクセス許可が必要です。詳細については、「の詳細を取得するためのアクセスを許可する AppClients」を参照してください。
リクエストフィールド
-
appClientId
- AppClient ID。
レスポンスフィールド
-
appName
- ユーザー AppFabric ポータルの同意ページに表示されるアプリケーションの名前。 -
customerManagedKeyIdentifier
(オプション) - データの暗号化に使用されるカスタマーマネージドキー (KMS が生成) の ARN です。指定しない場合、 AWS AppFabric マネージドキーが使用されます。 -
description
- アプリケーションの説明です。 -
redirectUrls
- 承認後にエンドユーザーがリダイレクトされる URI です。redirectUrls は 5 個まで追加できます。例えば、https://localhost:8080
などです。 -
starterUserEmails
- アプリケーションが検証されるまでの間、インサイトを受け取るためのアクセスが許可されるユーザーの E メールアドレスです。使用できるアドレスは 1 つのみです。例えば、anyuser@example.com
です。 -
verificationStatus
- AppClient 検証ステータス。-
pending_verification
- の検証は AppClientでまだ進行中です AppFabric。が検証されるまで、 を使用できるユーザー ( で指定starterUserEmails
) AppClient は 1 人のみです AppClient。 -
verified
- 検証プロセスが によって正常に完了 AppFabric し、 AppClient が完全に検証されました。 -
rejected
- の検証プロセスが によって拒否 AppClient されました AppFabric。検証プロセスが再開され、正常に完了するまでは、 を追加のユーザーが AppClient 使用することはできません。
-
curl --request GET \ --header "Content-Type: application/json" \ --header "X-Amz-Content-Sha256: <sha256_payload>" \ --header "X-Amz-Security-Token:
<security_token>
" \ --header "X-Amz-Date: 20230922T172215Z" \ --header "Authorization: AWS4-HMAC-SHA256 ..." \ --url https://appfabric.<region>
.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
200 OK { "appClient": { "appName": "Test App", "arn": "arn:aws:appfabric:
<region>
:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "customerManagedKeyArn": "arn:aws:kms:<region>
:111122223333:key/<key>
", "description": "This is a test app", "redirectUrls": [ "https://localhost:8080" ], "starterUserEmails": [ "anyuser@example.com" ], "verificationDetails": { "verificationStatus": "pending_verification" } } }
リスト AppClients
API AppFabric ListAppClients
オペレーションを使用して、 のリストを表示します AppClients。 AppClient ごとに 1 つの AppFabric のみを許可します AWS アカウント。この制限は将来変更される可能性があります。詳細については、「ListAppClients」を参照してください。
AppClientsを一覧表示するには、少なくとも IAM "appfabric:ListAppClients"
ポリシーのアクセス許可が必要です。詳細については、「リストへのアクセスを許可する AppClients」を参照してください。
リクエストフィールド
-
必須フィールドはありません。
レスポンスフィールド
-
appClientARN
- AppClient ID を含む Amazon リソースネーム (ARN)。例えば、 AppClient ID は ですa1b2c3d4-5678-90ab-cdef-EXAMPLE11111
。 -
verificationStatus
- AppClient 検証ステータス。-
pending_verification
- の検証は AppClientでまだ進行中です AppFabric。が検証されるまで、 を使用できるユーザー ( で指定starterUserEmails
) AppClient は 1 人のみです AppClient。 -
verified
- 検証プロセスが によって正常に完了 AppFabric し、 AppClient が完全に検証されました。 -
rejected
- の検証プロセスが によって拒否 AppClient されました AppFabric。検証プロセスが再開され、正常に完了するまでは、 を追加のユーザーが AppClient 使用することはできません。
-
curl --request GET \ --header "Content-Type: application/json" \ --header "X-Amz-Content-Sha256: <sha256_payload>" \ --header "X-Amz-Security-Token:
<security_token>
" \ --header "X-Amz-Date: 20230922T172215Z" \ --header "Authorization: AWS4-HMAC-SHA256 ..." \ --url https://appfabric.<region>
.amazonaws.com/appclients
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
200 OK { "appClientList": [ { "appClientArn": "arn:aws:appfabric:
<region>
:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "verificationStatus": "pending_verification" } ] }
の更新 AppClient
API AppFabric UpdateAppClient
オペレーションを使用して、 にマッピングされた redirectUrls を更新します AppClient。 AppName、、またはその他のパラメータを変更する必要がある場合は starterUserEmails、 を削除 AppClient して新しいパラメータを作成する必要があります。詳細については、「UpdateAppClient」を参照してください。
を更新するには AppClient、少なくとも IAM "appfabric:UpdateAppClient"
ポリシーのアクセス許可が必要です。詳細については、「更新へのアクセスを許可する AppClients」を参照してください。
リクエストフィールド
-
appClientId
(必須) - redirectUrls を更新する AppClient ID。 -
redirectUrls
(必須) - 更新された redirectUrls のリストです。redirectUrls は 5 個まで追加できます。
レスポンスフィールド
-
appName
- ユーザー AppFabric ポータルの同意ページに表示されるアプリケーションの名前。 -
customerManagedKeyIdentifier
(オプション) - データの暗号化に使用されるカスタマーマネージドキー (KMS が生成) の ARN です。指定しない場合、 AWS AppFabric マネージドキーが使用されます。 -
description
- アプリケーションの説明です。 -
redirectUrls
- 承認後にエンドユーザーがリダイレクトされる URI です。例えば、https://localhost:8080
です。 -
starterUserEmails
- アプリケーションが検証されるまでの間、インサイトを受け取るためのアクセスが許可されるユーザーの E メールアドレスです。使用できるアドレスは 1 つのみです。例えば、anyuser@example.com
です。 -
verificationStatus
- AppClient 検証ステータス。-
pending_verification
- の検証は AppClientでまだ進行中です AppFabric。が検証されるまで、 を使用できるユーザー ( で指定starterUserEmails
) AppClient は 1 人のみです AppClient。 -
verified
- 検証プロセスが によって正常に完了 AppFabric し、 AppClient が完全に検証されました。 -
rejected
- の検証プロセスが によって拒否 AppClient されました AppFabric。検証プロセスが再開され、正常に完了するまでは、 を追加のユーザーが AppClient 使用することはできません。
-
curl --request PATCH \ --header "Content-Type: application/json" \ --header "X-Amz-Content-Sha256: <sha256_payload>" \ --header "X-Amz-Security-Token:
<security_token>
" \ --header "X-Amz-Date: 20230922T172215Z" \ --header "Authorization: AWS4-HMAC-SHA256 ..." \ --url https://appfabric.<region>
.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --data '{ "redirectUrls": ["https://localhost:8081"] }'
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
200 OK { "appClient": { "appName": "Test App", "arn": "arn:aws:appfabric:
<region>
:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "customerManagedKeyArn": "arn:aws:kms:<region>
:111122223333:key/<key>
", "description": "This is a test app", "redirectUrls": [ "https://localhost:8081" ], "starterUserEmails": [ "anyuser@example.com" ], "verificationDetails": { "verificationStatus": "pending_verification" } } }
を削除する AppClient
API AppFabric DeleteAppClient
オペレーションを使用して、不要になった AppClients を削除します。詳細については、「DeleteAppClient」を参照してください。
を削除するには AppClient、少なくとも IAM "appfabric:DeleteAppClient"
ポリシーのアクセス許可が必要です。詳細については、「削除するアクセスを許可する AppClients」を参照してください。
リクエストフィールド
-
appClientId
- AppClient ID。
レスポンスフィールド
-
レスポンスフィールドはありません。
curl --request DELETE \ --header "Content-Type: application/json" \ --header "X-Amz-Content-Sha256: <sha256_payload>" \ --header "X-Amz-Security-Token:
<security_token>
" \ --header "X-Amz-Date: 20230922T172215Z" \ --header "Authorization: AWS4-HMAC-SHA256 ..." \ --url https://appfabric.<region>
.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
エンドユーザー用トークンを更新する
エンドユーザー用に AppClient 取得したトークンは、有効期限が切れると更新できます。これは トークン API と grant_type refresh_token
とを組み合わせて使用することで実行できます。grant_type が authorization_code
である場合は、使用すべき refresh_token
は、トークン API のレスポンスの一部として返されます。デフォルトの有効期限は 12 時間です。更新 API を呼び出すには、"appfabric:Token"
IAM ポリシーの許可が必要です。詳細については、「トークン」および「更新へのアクセスを許可する AppClients」を参照してください。
リクエストフィールド
-
refresh_token
(必須) - 最初の/token
リクエストで受け取った更新トークンです。 -
app_client_id
(必須) - 用に作成された AppClient リソースの ID AWS アカウント。 -
grant_type
(必須) -refresh_token
でなければなりません。
レスポンスフィールド
-
expires_in
- トークンの有効期限が切れるまでの残り時間です。デフォルトの有効期限は 12 時間です。 -
refresh_token
- 最初の /token リクエストで受け取った更新トークンです。 -
token
- 最初の /token リクエストで受け取ったトークンです。 -
token_type
- この値はBearer
になります。 -
appfabric_user_id
- AppFabric ユーザー ID。この値は、リクエストがauthorization_code
グラントタイプを使用している場合のみ返されます。
curl --location \ "https://appfabric.
<region>
.amazonaws.com/oauth2/token" \ --header "Content-Type: application/json" \ --header "X-Amz-Content-Sha256: <sha256_payload>" \ --header "X-Amz-Security-Token:<security_token>
" \ --header "X-Amz-Date: 20230922T172215Z" \ --header "Authorization: AWS4-HMAC-SHA256 ..." \ --data "{ \"refresh_token\": \"<refresh_token>
", \"app_client_id\": \"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\", \"grant_type\": \"refresh_token\" }"
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
200 OK { "expires_in": 43200, "token": "apkaeibaerjr2example", "token_type": "Bearer", "appfabric_user_id" : "${UserID}" }