本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
管理提升 AppFabric 生產力 AppClients
提高 AWS AppFabric 生產力功能為預覽狀態,可能會有所變更。 |
您可以管理您 AppFabric 的生產力, AppClients 以確保身份驗證和授權過程的順利運行和維護。
獲取的詳細信息 AppClient
使用 AppFabric GetAppClient
API 操作可查看有關您的詳細信息 AppClient,包括檢查 AppClient 狀態。如需詳細資訊,請參閱 GetAppClient。
若要取得的詳細資訊 AppClient,您至少必須擁有 "appfabric:GetAppClient"
IAM 政策許可。如需詳細資訊,請參閱 允許存取以取得詳細資料 AppClients。
請求欄位
-
appClientId
-身 AppClient 份證
響應字段
-
appName
-將在使用 AppFabric 者入口網站的同意頁面上顯示給使用者的應用程式名稱。 -
customerManagedKeyIdentifier
(選擇性)-用於加密資料的客戶受管金鑰 (由 KMS 產生) 的 ARN。如果未指定,則將使用 AWS AppFabric 託管密鑰。 -
description
-應用程序的說明。 -
redirectUrls
-授權後將使用者重新導向至的 URI。您最多可以新增 5 個重新導向。例如https://localhost:8080
。 -
starterUserEmails
-一個用戶電子郵件地址,允許訪問以接收見解,直到應用程序通過驗證。只允許使用一個電子郵件地址。例如anyuser@example.com
。 -
verificationStatus
- AppClient 驗證狀態。-
pending_verification
-的驗證 AppClient仍在進行中 AppFabric。在驗證之 AppClient 前,只有一個使用者 (在中指定starterUserEmails
) 可以使用 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
使用 AppFabric ListAppClients
API 作業檢視您的 AppClients. AppFabric 每個只允許一 AppClient 個 AWS 帳戶。這可能會在 future 發生變化。如需詳細資訊,請參閱 ListAppClients。
若要列出 AppClients,您至少必須擁有 "appfabric:ListAppClients"
IAM 政策許可。如需詳細資訊,請參閱 允許存取清單 AppClients。
請求欄位
-
沒有必填欄位。
響應字段
-
appClientARN
-包含 AppClient ID 的 Amazon 資源名稱 (ARN)。例如, AppClient 識別碼為a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
。 -
verificationStatus
- AppClient 驗證狀態。-
pending_verification
-的驗證 AppClient仍在進行中 AppFabric。在驗證之 AppClient 前,只有一個使用者 (在中指定starterUserEmails
) 可以使用 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
使用 AppFabric UpdateAppClient
API 作業更新對應至您的. AppClient 如果您需要變更任何其他參數,例如 AppName starterUserEmails、或其他參數,您必須刪除 AppClient 並建立新參數。如需詳細資訊,請參閱 UpdateAppClient。
若要更新 AppClient,您至少必須擁有 "appfabric:UpdateAppClient"
IAM 政策許可。如需詳細資訊,請參閱 允許存取更新 AppClients。
請求欄位
-
appClientId
(必要)-您要更新重新導覽的 AppClient ID。 -
redirectUrls
(必要)-重新導向的更新清單。您最多可以新增 5 個重新導向。
響應字段
-
appName
-將在使用 AppFabric 者入口網站的同意頁面上顯示給使用者的應用程式名稱。 -
customerManagedKeyIdentifier
(選擇性)-用於加密資料的客戶受管金鑰 (由 KMS 產生) 的 ARN。如果未指定,則將使用 AWS AppFabric 託管密鑰。 -
description
-應用程序的說明。 -
redirectUrls
-授權後將使用者重新導向至的 URI。例如https://localhost:8080
。 -
starterUserEmails
-一個用戶電子郵件地址,允許訪問以接收見解,直到應用程序通過驗證。只允許使用一個電子郵件地址。例如anyuser@example.com
。 -
verificationStatus
- AppClient 驗證狀態。-
pending_verification
-的驗證 AppClient仍在進行中 AppFabric。在驗證之 AppClient 前,只有一個使用者 (在中指定starterUserEmails
) 可以使用 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
使用 AppFabric DeleteAppClient
API 操作刪除 AppClients 您不再需要的任何內容。如需詳細資訊,請參閱 DeleteAppClient。
若要刪除 AppClient,您至少必須擁有 "appfabric:DeleteAppClient"
IAM 政策許可。如需詳細資訊,請參閱 允許存取刪除 AppClients。
請求欄位
-
appClientId
-身 AppClient 份證
響應字段
-
沒有響應字段。
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 獲取的令牌可以在到期時刷新。這可以使用帶有 grant refresh_token
_ 權杖 type 的 API 來完成。當 grant_type 為時,將refresh_token
要使用的作為權杖 API 回應的一部分傳回。authorization_code
預設到期日為 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 使用者識別碼。這只會針對使用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}" }