As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Gerenciando AppFabric a produtividade AppClients
O recurso AWS AppFabric de produtividade está em versão prévia e está sujeito a alterações. |
Você pode gerenciar sua produtividade AppFabric para garantir AppClients a operação e a manutenção sem problemas dos processos de autenticação e autorização.
Obtenha detalhes de um AppClient
Use a operação AppFabric GetAppClient
da API para ver detalhes sobre sua AppClient, incluindo verificar o AppClient status. Para ter mais informações, consulte GetAppClient.
Para obter detalhes de um AppClient, você deve ter, no mínimo, as permissões da política "appfabric:GetAppClient"
do IAM. Para ter mais informações, consulte Permita o acesso para obter detalhes de AppClients.
Campos de solicitação
-
appClientId
- O AppClient ID.
Campos de resposta
-
appName
- O nome do aplicativo que será exibido aos usuários na página de consentimento do portal do AppFabric usuário. -
customerManagedKeyIdentifier
(opcional): o ARN da chave gerenciada pelo cliente (gerada pelo KMS) a ser usada para criptografar os dados. Se não for especificado, a chave AWS AppFabric gerenciada será usada. -
description
: uma descrição da aplicação. -
redirectUrls
: o URI para o qual redirecionar os usuários finais após a autorização. É possível adicionar até 5 redirectUrls. Por exemplo,https://localhost:8080
. -
starterUserEmails
: um endereço de email do usuário que terá acesso para receber as informações até que a aplicação seja verificada. Só é permitido um endereço de email. Por exemplo,anyuser@example.com
. -
verificationStatus
- O status da AppClient verificação.-
pending_verification
- A verificação do ainda AppClient está em andamento com AppFabric. Até que AppClient seja verificado, somente um usuário (especificado emstarterUserEmails
) pode usar AppClient o. -
verified
- O processo de verificação foi concluído com sucesso AppFabric e agora AppClient está totalmente verificado. -
rejected
- O processo de verificação do AppClient foi rejeitado por AppFabric. Eles AppClient não podem ser usados por usuários adicionais até que o processo de verificação seja reiniciado e concluído com êxito.
-
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
Se a ação for bem-sucedida, o serviço retornará uma resposta 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" } } }
Lista AppClients
Use a operação de AppFabric ListAppClients
API para ver uma lista de seus AppClients. AppFabric só permite um AppClient por Conta da AWS. Isso está sujeito a alterações no futuro. Para ter mais informações, consulte ListAppClients.
Para listar AppClients, você deve ter, no mínimo, as permissões da política "appfabric:ListAppClients"
do IAM. Para ter mais informações, consulte Permitir acesso à lista AppClients.
Campos de solicitação
-
Não há campos obrigatórios.
Campos de resposta
-
appClientARN
- O nome de recurso da Amazon (ARN) que inclui o AppClient ID. Por exemplo, o AppClient ID éa1b2c3d4-5678-90ab-cdef-EXAMPLE11111
. -
verificationStatus
- O status da AppClient verificação.-
pending_verification
- A verificação do ainda AppClient está em andamento com AppFabric. Até que AppClient seja verificado, somente um usuário (especificado emstarterUserEmails
) pode usar AppClient o. -
verified
- O processo de verificação foi concluído com sucesso AppFabric e agora AppClient está totalmente verificado. -
rejected
- O processo de verificação do AppClient foi rejeitado por AppFabric. Eles AppClient não podem ser usados por usuários adicionais até que o processo de verificação seja reiniciado e concluído com êxito.
-
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
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
200 OK { "appClientList": [ { "appClientArn": "arn:aws:appfabric:
<region>
:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "verificationStatus": "pending_verification" } ] }
Atualizar um AppClient
Use a operação da AppFabric UpdateAppClient
API para atualizar os redirectUrls mapeados para o seu. AppClient Se precisar alterar qualquer outro parâmetro, como AppName starterUserEmails, ou outro, exclua o AppClient e crie um novo. Para ter mais informações, consulte UpdateAppClient.
Para atualizar um AppClient, você deve ter, no mínimo, as permissões da política "appfabric:UpdateAppClient"
do IAM. Para ter mais informações, consulte Permitir acesso à atualização AppClients.
Campos de solicitação
-
appClientId
(obrigatório) - O AppClient ID com o qual você está atualizando os RedirectUrls. -
redirectUrls
(obrigatório): a lista atualizada dos redirectUrls. É possível adicionar até 5 redirectUrls.
Campos de resposta
-
appName
- O nome do aplicativo que será exibido aos usuários na página de consentimento do portal do AppFabric usuário. -
customerManagedKeyIdentifier
(opcional): o ARN da chave gerenciada pelo cliente (gerada pelo KMS) a ser usada para criptografar os dados. Se não for especificado, a chave AWS AppFabric gerenciada será usada. -
description
: uma descrição da aplicação. -
redirectUrls
: o URI para o qual redirecionar os usuários finais após a autorização. Por exemplo,https://localhost:8080
. -
starterUserEmails
: um endereço de email do usuário que terá acesso para receber as informações até que a aplicação seja verificada. Só é permitido um endereço de email. Por exemplo,anyuser@example.com
. -
verificationStatus
- O status da AppClient verificação.-
pending_verification
- A verificação do ainda AppClient está em andamento com AppFabric. Até que AppClient seja verificado, somente um usuário (especificado emstarterUserEmails
) pode usar AppClient o. -
verified
- O processo de verificação foi concluído com sucesso AppFabric e agora AppClient está totalmente verificado. -
rejected
- O processo de verificação do AppClient foi rejeitado por AppFabric. Eles AppClient não podem ser usados por usuários adicionais até que o processo de verificação seja reiniciado e concluído com êxito.
-
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"] }'
Se a ação for bem-sucedida, o serviço retornará uma resposta 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" } } }
Excluir um AppClient
Use a operação AppFabric DeleteAppClient
da API para excluir as AppClients que você não precisa mais. Para ter mais informações, consulte DeleteAppClient.
Para excluir um AppClient, você deve ter, no mínimo, as permissões da política "appfabric:DeleteAppClient"
do IAM. Para ter mais informações, consulte Permitir acesso para excluir AppClients.
Campos de solicitação
-
appClientId
- O AppClient ID.
Campos de resposta
-
Não há campos de resposta.
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
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
Atualizar tokens para usuários finais
Os tokens que você AppClient adquire para os usuários finais podem ser atualizados no vencimento. Isso pode ser feito usando a API Token com o grant_type refresh_token
. O refresh_token
a ser usado é retornado como parte da resposta da API do token quando o grant_type for authorization_code
. O tempo de expiração padrão é de 12 horas. Para chamar a API de atualização, você precisa ter a permissão da política do IAM "appfabric:Token"
. Para obter mais informações, consulte Token e Permitir acesso à atualização AppClients.
Campos de solicitação
-
refresh_token
(obrigatório): o token de atualização recebido da solicitação/token
inicial. -
app_client_id
(obrigatório) - O ID do AppClient recurso criado para Conta da AWS o. -
grant_type
(obrigatório): isso deve serrefresh_token
.
Campos de resposta
-
expires_in
: quanto tempo falta para o token expirar. O tempo de expiração padrão é de 12 horas. -
refresh_token
: o token de atualização recebido da solicitação inicial do token. -
token
: o token recebido da solicitação inicial do token. -
token_type
: o valor seráBearer
. -
appfabric_user_id
- O ID AppFabric do usuário. Isso é retornado somente para solicitações que usem o tipo de concessãoauthorization_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\" }"
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
200 OK { "expires_in": 43200, "token": "apkaeibaerjr2example", "token_type": "Bearer", "appfabric_user_id" : "${UserID}" }