Obtenez les détails d'un AppClient Liste AppClients Mettre à jour un AppClient Supprimer un AppClient Actualiser les jetons pour les utilisateurs finaux

Gestion axée sur AppFabric la productivité AppClients

La fonctionnalité AWS AppFabric de productivité est en cours d'aperçu et est sujette à modification.

Vous pouvez gérer votre productivité AppClients afin AppFabric de garantir le bon fonctionnement et la maintenance des processus d'authentification et d'autorisation.

Obtenez les détails d'un AppClient

Utilisez le fonctionnement de l' AppFabric GetAppClientAPI pour afficher les informations vous concernant AppClient, notamment pour vérifier AppClient son statut. Pour plus d’informations, consultez GetAppClient.

Pour obtenir des informations sur un AppClient, vous devez disposer, au minimum, des autorisations de politique "appfabric:GetAppClient" IAM. Pour plus d’informations, consultez Autoriser l'accès pour obtenir des informations sur AppClients.

Champs de demande

appClientId- L' AppClient identifiant.

Champs de réponse

appName- Le nom de l'application qui sera affiché aux utilisateurs sur la page de consentement du portail AppFabric utilisateur.
customerManagedKeyIdentifier(facultatif) - L'ARN de la clé gérée par le client (générée par KMS) à utiliser pour chiffrer les données. Si elle n'est pas spécifiée, la clé AWS AppFabric gérée sera utilisée.
description- Une description de l'application.
redirectUrls- L'URI vers lequel rediriger les utilisateurs finaux après autorisation. Vous pouvez ajouter jusqu'à 5 URL de redirection. Par exemple, https://localhost:8080.
starterUserEmails- Une adresse e-mail d'utilisateur qui sera autorisée à accéder pour recevoir les informations jusqu'à ce que l'application soit vérifiée. Une seule adresse e-mail est autorisée. Par exemple, anyuser@example.com.
verificationStatus- L'état AppClient de la vérification.
- pending_verification- La vérification du AppClient est toujours en cours avec AppFabric. Jusqu'à ce que le AppClient soit vérifié, un seul utilisateur (spécifié dansstarterUserEmails) peut utiliser le AppClient.
- verified- Le processus de vérification a été effectué avec succès AppFabric et AppClient est maintenant entièrement vérifié.
- rejected- Le processus de vérification du AppClient a été rejeté par AppFabric. Il AppClient ne peut pas être utilisé par d'autres utilisateurs tant que le processus de vérification n'est pas relancé et terminé avec succès.


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

Si l’action aboutit, le service renvoie une réponse 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"
        }
    }
}

Liste AppClients

Utilisez l'opération AppFabric ListAppClients API pour afficher la liste de vos AppClients. AppFabric n'en autorise qu'un AppClient par Compte AWS. Ceci est sujet à modification dans le futur. Pour plus d’informations, consultez ListAppClients.

Pour créer une liste AppClients, vous devez disposer, au minimum, des autorisations de politique "appfabric:ListAppClients" IAM. Pour plus d’informations, consultez Autoriser l'accès à la liste AppClients.

Champs de demande

Il n'y a aucun champ obligatoire.

Champs de réponse

appClientARN- Le nom de ressource Amazon (ARN) qui inclut l' AppClient ID. Par exemple, l' AppClient identifiant esta1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
verificationStatus- L'état AppClient de la vérification.
- pending_verification- La vérification du AppClient est toujours en cours avec AppFabric. Jusqu'à ce que le AppClient soit vérifié, un seul utilisateur (spécifié dansstarterUserEmails) peut utiliser le AppClient.
- verified- Le processus de vérification a été effectué avec succès AppFabric et AppClient est maintenant entièrement vérifié.
- rejected- Le processus de vérification du AppClient a été rejeté par AppFabric. Il AppClient ne peut pas être utilisé par d'autres utilisateurs tant que le processus de vérification n'est pas relancé et terminé avec succès.


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

Si l’action aboutit, le service renvoie une réponse HTTP 200.


200 OK

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

Mettre à jour un AppClient

Utilisez l'opération AppFabric UpdateAppClient API pour mettre à jour les URL de redirection mappées à votre. AppClient Si vous devez modifier d'autres paramètres, tels que AppName starterUserEmails, ou autre, vous devez les supprimer AppClient et en créer un nouveau. Pour plus d’informations, consultez UpdateAppClient.

Pour mettre à jour un AppClient, vous devez disposer, au minimum, des autorisations de politique "appfabric:UpdateAppClient" IAM. Pour plus d’informations, consultez Autoriser l'accès à la mise à jour AppClients.

Champs de demande

appClientId(obligatoire) - L' AppClient ID avec lequel vous mettez à jour les URL de redirection.
redirectUrls(obligatoire) - La liste mise à jour des URL de redirection. Vous pouvez ajouter jusqu'à 5 URL de redirection.

Champs de réponse

appName- Le nom de l'application qui sera affiché aux utilisateurs sur la page de consentement du portail AppFabric utilisateur.
customerManagedKeyIdentifier(facultatif) - L'ARN de la clé gérée par le client (générée par KMS) à utiliser pour chiffrer les données. Si elle n'est pas spécifiée, la clé AWS AppFabric gérée sera utilisée.
description- Une description de l'application.
redirectUrls- L'URI vers lequel rediriger les utilisateurs finaux après autorisation. Par exemple, https://localhost:8080.
starterUserEmails- Une adresse e-mail d'utilisateur qui sera autorisée à accéder pour recevoir les informations jusqu'à ce que l'application soit vérifiée. Une seule adresse e-mail est autorisée. Par exemple, anyuser@example.com.
verificationStatus- L'état AppClient de la vérification.
- pending_verification- La vérification du AppClient est toujours en cours avec AppFabric. Jusqu'à ce que le AppClient soit vérifié, un seul utilisateur (spécifié dansstarterUserEmails) peut utiliser le AppClient.
- verified- Le processus de vérification a été effectué avec succès AppFabric et AppClient est maintenant entièrement vérifié.
- rejected- Le processus de vérification du AppClient a été rejeté par AppFabric. Il AppClient ne peut pas être utilisé par d'autres utilisateurs tant que le processus de vérification n'est pas relancé et terminé avec succès.


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"]
}'

Si l’action aboutit, le service renvoie une réponse 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"
        }
    }
}

Supprimer un AppClient

Utilisez l'opération AppFabric DeleteAppClient API pour supprimer celles dont AppClients vous n'avez plus besoin. Pour plus d’informations, consultez DeleteAppClient.

Pour supprimer un AppClient, vous devez disposer, au minimum, des autorisations de politique "appfabric:DeleteAppClient" IAM. Pour plus d’informations, consultez Autoriser l'accès pour supprimer AppClients.

Champs de demande

appClientId- L' AppClient identifiant.

Champs de réponse

Il n'y a aucun champ de réponse.


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

Si l’action aboutit, le service renvoie une réponse HTTP 204 avec un corps HTTP vide.

Actualiser les jetons pour les utilisateurs finaux

Les jetons que vous AppClient obtenez pour les utilisateurs finaux peuvent être actualisés à leur expiration. Cela peut être fait à l'aide de l'JetonAPI avec le grant_typerefresh_token. Le refresh_token à utiliser est renvoyé dans le cadre de la réponse de l'API token lorsque le grant_type est. authorization_code Le délai d'expiration par défaut est de 12 heures. Pour appeler l'API d'actualisation, vous devez disposer de l'autorisation de politique "appfabric:Token" IAM. Pour plus d’informations, consultez Jeton et Autoriser l'accès à la mise à jour AppClients.

Champs de demande

refresh_token(obligatoire) - Le jeton d'actualisation reçu lors de la /token demande initiale.
app_client_id(obligatoire) - L'ID de la AppClient ressource créée pour Compte AWS.
grant_type(obligatoire) - Cela doit être le casrefresh_token.

Champs de réponse

expires_in- Combien de temps avant l'expiration du jeton. Le délai d'expiration par défaut est de 12 heures.
refresh_token- Le jeton d'actualisation reçu lors de la demande initiale /token.
token- Le jeton reçu lors de la demande initiale /token.
token_type- La valeur sera deBearer.
appfabric_user_id- L'identifiant de AppFabric l'utilisateur. Ceci n'est renvoyé que pour les demandes utilisant le type de authorization_code subvention.


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\"
}"

Si l’action aboutit, le service renvoie une réponse HTTP 200.


200 OK

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

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Démarrage pour les développeurs d'applications

Résolution des problèmes