Obtenha detalhes de um AppClient Lista AppClients Atualizar um AppClient Excluir um AppClient Atualizar tokens para usuários finais

Gerencie AppFabric para aumentar a produtividade AppClients

A ferramenta AWS AppFabric o recurso 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 AppFabric GetAppClient API operação para ver detalhes sobre o seu AppClient, incluindo verificar o AppClient status. Para obter mais informações, consulte GetAppClient.

Para obter detalhes de um AppClient, você deve ter, no mínimo, as permissões da "appfabric:GetAppClient" IAM política. Para obter 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) - A ARN chave gerenciada pelo cliente (gerada porKMS) a ser usada para criptografar os dados. Se não for especificado, então AWS AppFabric A chave gerenciada será usada.
description: uma descrição da aplicação.
redirectUrls- O URI para redirecionar os usuários finais para após a autorização. Você pode adicionar até 5redirectUrls. 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 de 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 AppFabric ListAppClients API operação 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 obter mais informações, consulte ListAppClients.

Para listar AppClients, você deve ter, no mínimo, as permissões da "appfabric:ListAppClients" IAM política. Para obter mais informações, consulte Permitir acesso à lista AppClients.

Campos de solicitação

Não há campos obrigatórios.

Campos de resposta

appClientARN- O nome do 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 de 200.


200 OK

{
    "appClientList": [
        {
            "appClientArn": "arn:aws:appfabric:<region>:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "verificationStatus": "pending_verification"
        }
    ]
}

Atualizar um AppClient

Use a AppFabric UpdateAppClient API operação para atualizar o redirectUrls mapeado para o seu AppClient. Se precisar alterar qualquer outro parâmetro, como AppName starterUserEmails, ou outro, exclua o AppClient e crie um novo. Para obter mais informações, consulte UpdateAppClient.

Para atualizar uma AppClient, você deve ter, no mínimo, as permissões da "appfabric:UpdateAppClient" IAM política. Para obter mais informações, consulte Permitir acesso à atualização AppClients.

Campos de solicitação

appClientId(obrigatório) - O AppClient ID com o qual você está atualizandoredirectUrls.
redirectUrls(obrigatório) - A lista atualizada doredirectUrls. Você pode adicionar até 5redirectUrls.

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) - A ARN chave gerenciada pelo cliente (gerada porKMS) a ser usada para criptografar os dados. Se não for especificado, então AWS AppFabric A chave gerenciada será usada.
description: uma descrição da aplicação.
redirectUrls- O URI para redirecionar os usuários finais para 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 de 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 AppFabric DeleteAppClient API operação para excluir as AppClients que você não precisa mais. Para obter mais informações, consulte DeleteAppClient.

Para excluir um AppClient, você deve ter, no mínimo, as permissões da "appfabric:DeleteAppClient" IAM política. Para obter 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 o HTTP corpo 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 o Token API com o refresh_token grant_type. O refresh_token a ser usado é retornado como parte da API resposta do token quando o grant_type é. authorization_code O tempo de expiração padrão é de 12 horas. Para chamar a atualizaçãoAPI, você deve ter a permissão da "appfabric:Token" IAM política. Para ter 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 o Conta da AWS.
grant_type (obrigatório): isso deve ser refresh_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ão 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\"
}"

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.


200 OK

{
    "expires_in": 43200,
    "token": "apkaeibaerjr2example",
    "token_type": "Bearer",
    "appfabric_user_id" : "${UserID}"
}

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Comece a usar para desenvolvedores de aplicativos

Solução de problemas