Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Exemples d'utilisation du fournisseur d'identité Amazon Cognito AWS CLI
Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du fournisseur AWS Command Line Interface d'identité Amazon Cognito.
Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utiliseradd-custom-attributes.
- AWS CLI
-
Pour ajouter un attribut personnalisé
Cet exemple ajoute un attribut personnalisé CustomAttr 1 à un groupe d'utilisateurs. Il s’agit d’un type de chaîne qui nécessite 1 caractère minimum et 15 maximum. Il n’est pas obligatoire.
Commande :
aws cognito-idp add-custom-attributes --user-pool-idus-west-2_aaaaaaaaa--custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"-
Pour plus de détails sur l'API, reportez-vous AddCustomAttributes
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-add-user-to-group.
- AWS CLI
-
Pour ajouter un utilisateur à un groupe
Cet exemple ajoute l'utilisateur Jane au groupe MyGroup.
Commande :
aws cognito-idp admin-add-user-to-group --user-pool-idus-west-2_aaaaaaaaa--usernameJane--group-nameMyGroup-
Pour plus de détails sur l'API, reportez-vous AdminAddUserToGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-confirm-sign-up.
- AWS CLI
-
Pour confirmer l’enregistrement de l’utilisateur
Cet exemple confirme l’utilisateur jane@example.com.
Commande :
aws cognito-idp admin-confirm-sign-up --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com-
Pour plus de détails sur l'API, reportez-vous AdminConfirmSignUp
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-create-user.
- AWS CLI
-
Pour créer un utilisateur
L’exemple
admin-create-usersuivant crée un utilisateur avec l’adresse e-mail et le numéro de téléphone spécifiés dans les paramètres.aws cognito-idp admin-create-user \ --user-pool-idus-west-2_aaaaaaaaa\ --usernamediego\ --user-attributesName=email,Value=diego@example.comName=phone_number,Value="+15555551212" \ --message-actionSUPPRESSSortie :
{ "User": { "Username": "diego", "Attributes": [ { "Name": "sub", "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" }, { "Name": "phone_number", "Value": "+15555551212" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548099495.428, "UserLastModifiedDate": 1548099495.428, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } }-
Pour plus de détails sur l'API, reportez-vous AdminCreateUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-delete-user-attributes.
- AWS CLI
-
Pour supprimer un attribut utilisateur
Cet exemple supprime un attribut personnalisé CustomAttr 1 pour l'utilisateur diego@example.com.
Commande :
aws cognito-idp admin-delete-user-attributes --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--user-attribute-names"custom:CustomAttr1"-
Pour plus de détails sur l'API, reportez-vous AdminDeleteUserAttributes
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-delete-user.
- AWS CLI
-
Pour supprimer un utilisateur
Cet exemple supprime un utilisateur.
Commande :
aws cognito-idp admin-delete-user --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com-
Pour plus de détails sur l'API, reportez-vous AdminDeleteUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-disable-provider-for-user.
- AWS CLI
-
Pour dissocier un utilisateur fédéré d’un profil utilisateur local
L’exemple
admin-disable-provider-for-usersuivant déconnecte un utilisateur de Google de son profil local associé.aws cognito-idp admin-disable-provider-for-user \ --user-pool-idus-west-2_EXAMPLE\ --userProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=GooglePour plus d’informations, consultez Liaison d’utilisateurs fédérés à un profil utilisateur existant dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminDisableProviderForUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-disable-user.
- AWS CLI
-
Pour empêcher la connexion d’un utilisateur
L’exemple
admin-disable-usersuivant empêche l’utilisateurdiego@example.comde se connecter.aws cognito-idp admin-disable-user \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPour plus d’informations, consultez Gestion des utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminDisableUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-enable-user.
- AWS CLI
-
Pour permettre la connexion d’un utilisateur
L’exemple
admin-enable-usersuivant permet à l’utilisateur diego@example.com de se connecter.aws cognito-idp admin-enable-user \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPour plus d’informations, consultez Gestion des utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminEnableUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-forget-device.
- AWS CLI
-
Pour oublier un appareil
Cet exemple oublie l’appareil pour le nom d’utilisateur jane@example.com.
Commande :
aws cognito-idp admin-forget-device --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com--device-keyus-west-2_abcd_1234-5678-
Pour plus de détails sur l'API, reportez-vous AdminForgetDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-get-device.
- AWS CLI
-
Pour obtenir un appareil
L’exemple
admin-get-devicesuivant affiche un appareil pour l’utilisateurdiego.aws cognito-idp admin-get-device \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Sortie :
{ "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } }Pour plus d’informations, consultez Utilisation d’appareils utilisateur dans votre groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminGetDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-get-user.
- AWS CLI
-
Pour obtenir un utilisateur
Cet exemple permet d’obtenir les informations sur le nom d’utilisateur jane@example.com.
Commande :
aws cognito-idp admin-get-user --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.comSortie :
{ "Username": "4320de44-2322-4620-999b-5e2e1c8df013", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548108509.537, "UserAttributes": [ { "Name": "sub", "Value": "4320de44-2322-4620-999b-5e2e1c8df013" }, { "Name": "email_verified", "Value": "true" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+01115551212" }, { "Name": "email", "Value": "jane@example.com" } ], "UserLastModifiedDate": 1548108509.537 }-
Pour plus de détails sur l'API, reportez-vous AdminGetUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-initiate-auth.
- AWS CLI
-
Pour vous connecter en tant qu’administrateur
L’exemple
admin-initiate-authsuivant connecte l’utilisateur diego@example.com. Cet exemple inclut également des métadonnées pour la protection contre les menaces et ClientMetadata pour les déclencheurs Lambda. L’utilisateur est configuré pour l’authentification MFA par TOTP et est invité à fournir un code depuis son application d’authentification avant de pouvoir terminer l’authentification.aws cognito-idp admin-initiate-auth \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --auth-flowADMIN_USER_PASSWORD_AUTH\ --auth-parameters USERNAME=diego@example.com,PASSWORD="My@Example$Password3!",SECRET_HASH=ExampleEncodedClientIdSecretAndUsername= \ --context-data="{\"EncodedData\":\"abc123example\",\"HttpHeaders\":[{\"headerName\":\"UserAgent\",\"headerValue\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"}],\"IpAddress\":\"192.0.2.1\",\"ServerName\":\"example.com\",\"ServerPath\":\"/login\"}" \ --client-metadata="{\"MyExampleKey\": \"MyExampleValue\"}"Sortie :
{ "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeExample...", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "MyAuthenticatorApp", "USER_ID_FOR_SRP": "diego@example.com" } }Pour plus d’informations, consultez Flux d’authentification de l’administration dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminInitiateAuth
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-link-provider-for-user.
- AWS CLI
-
Pour lier un utilisateur local à un utilisateur fédéré
L’exemple
admin-link-provider-for-usersuivant lie l’utilisateur local diego à un utilisateur qui effectuera une connexion fédérée avec Google.aws cognito-idp admin-link-provider-for-user \ --user-pool-idus-west-2_EXAMPLE\ --destination-userProviderName=Cognito,ProviderAttributeValue=diego\ --source-userProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=GooglePour plus d’informations, consultez Liaison d’utilisateurs fédérés à un profil utilisateur existant dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminLinkProviderForUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-list-devices.
- AWS CLI
-
Pour répertorier les appareils d’un utilisateur
L’exemple
admin-list-devicessuivant répertorie les appareils de l’utilisateur diego.aws cognito-idp admin-list-devices \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego\ --limit1Sortie :
{ "Devices": [ { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } ] }Pour plus d’informations, consultez Utilisation d’appareils utilisateur dans votre groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminListDevices
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-list-groups-for-user.
- AWS CLI
-
Pour répertorier les groupes d’un utilisateur
Cet exemple répertorie les groupes pour le nom d’utilisateur jane@example.com.
Commande :
aws cognito-idp admin-list-groups-for-user --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.comSortie :
{ "Groups": [ { "Description": "Sample group", "Precedence": 1, "LastModifiedDate": 1548097827.125, "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", "GroupName": "SampleGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "CreationDate": 1548097827.125 } ] }-
Pour plus de détails sur l'API, reportez-vous AdminListGroupsForUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-list-user-auth-events.
- AWS CLI
-
Pour répertorier les événements d’autorisation d’un utilisateur
L’exemple
admin-list-user-auth-eventssuivant répertorie le dernier événement du journal d’activité des utilisateurs pour l’utilisateur diego.aws cognito-idp admin-list-user-auth-events \ --user-pool-idus-west-2_ywDJHlIfU\ --usernamebrcotter+050123\ --max-results1Sortie :
{ "AuthEvents": [ { "EventId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "EventType": "SignIn", "CreationDate": 1726694203.495, "EventResponse": "InProgress", "EventRisk": { "RiskDecision": "AccountTakeover", "RiskLevel": "Medium", "CompromisedCredentialsDetected": false }, "ChallengeResponses": [ { "ChallengeName": "Password", "ChallengeResponse": "Success" } ], "EventContextData": { "IpAddress": "192.0.2.1", "City": "Seattle", "Country": "United States" } } ], "NextToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222#2024-09-18T21:16:43.495Z" }Pour plus d’informations, consultez Afficher et exporter l’historique des événements des utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminListUserAuthEvents
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-remove-user-from-group.
- AWS CLI
-
Pour supprimer un utilisateur d’un groupe
Cet exemple supprime jane@example.com de SampleGroup.
Commande :
aws cognito-idp admin-remove-user-from-group --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com--group-nameSampleGroup-
Pour plus de détails sur l'API, reportez-vous AdminRemoveUserFromGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-reset-user-password.
- AWS CLI
-
Pour réinitialiser le mot de passe d'un utilisateur
Cet exemple réinitialise le mot de passe pour diego@example.com.
Commande :
aws cognito-idp admin-reset-user-password --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com-
Pour plus de détails sur l'API, reportez-vous AdminResetUserPassword
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-respond-to-auth-challenge.
- AWS CLI
-
Pour répondre à une stimulation d’authentification
Il existe de nombreuses manières de répondre aux différentes stimulations d’authentification, en fonction de votre flux d’authentification, de la configuration du groupe d’utilisateurs et des paramètres utilisateur. L’exemple
admin-respond-to-auth-challengesuivant fournit un code d’authentification MFA par TOTP pour diego@example.com et termine la connexion. La mémorisation des appareils de ce groupe d’utilisateurs est activée, de sorte que le résultat de l’authentification renvoie également une nouvelle clé d’appareil.aws cognito-idp admin-respond-to-auth-challenge \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --challenge-nameSOFTWARE_TOKEN_MFA\ --challenge-responsesUSERNAME=diego@example.com,SOFTWARE_TOKEN_MFA_CODE=000000\ --sessionAYABeExample...Sortie :
{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-ExAmPlE1" } } }Pour plus d’informations, consultez Flux d’authentification de l’administration dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminRespondToAuthChallenge
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-set-user-mfa-preference.
- AWS CLI
-
Pour définir les préférences d’authentification MFA de l’utilisateur
Cet exemple définit la préférence d’authentification MFA sur SMS pour le nom d’utilisateur diego@example.com.
Commande :
aws cognito-idp admin-set-user-mfa-preference --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--sms-mfa-settingsEnabled=false,PreferredMfa=false-
Pour plus de détails sur l'API, reportez-vous AdminSetUserMfaPreference
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-set-user-password.
- AWS CLI
-
Pour définir un mot de passe utilisateur en tant qu’administrateur
L’exemple
admin-set-user-passwordsuivant définit définitivement le mot de passe pour diego@example.com.aws cognito-idp admin-set-user-password \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.com\ --passwordMyExamplePassword1!\ --permanentCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Passwords, password recovery, and password policies dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminSetUserPassword
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-set-user-settings.
- AWS CLI
-
Pour définir les paramètres utilisateur
Cet exemple définit la préférence d’obtention de l’authentification MFA pour le nom d’utilisateur diego@example.com sur E-MAIL.
Commande :
aws cognito-idp admin-set-user-settings --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--mfa-optionsDeliveryMedium=EMAIL-
Pour plus de détails sur l'API, reportez-vous AdminSetUserSettings
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-update-auth-event-feedback.
- AWS CLI
-
Pour fournir des commentaires concernant un événement d’autorisation
Cet exemple définit la valeur de commentaires pour un événement d’autorisation identifié par event-id sur Valid.
Commande :
aws cognito-idp admin-update-auth-event-feedback --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--event-idc2c2cf89-c0d3-482d-aba6-99d78a5b0bfe--feedback-valueValid-
Pour plus de détails sur l'API, reportez-vous AdminUpdateAuthEventFeedback
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-update-device-status.
- AWS CLI
-
Pour mettre à jour le statut de l’appareil
Cet exemple définit le statut de mémorisation d’appareil pour l’appareil identifié par device-key sur not_remembered.
Commande :
aws cognito-idp admin-update-device-status --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--device-keyxxxx--device-remembered-statusnot_remembered-
Pour plus de détails sur l'API, reportez-vous AdminUpdateDeviceStatus
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-update-user-attributes.
- AWS CLI
-
Pour mettre à jour des attributs utilisateur
Cet exemple met à jour un attribut utilisateur personnalisé CustomAttr 1 pour l'utilisateur diego@example.com.
Commande :
aws cognito-idp admin-update-user-attributes --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--user-attributes Name="custom:CustomAttr1",Value="Purple"-
Pour plus de détails sur l'API, reportez-vous AdminUpdateUserAttributes
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseradmin-user-global-sign-out.
- AWS CLI
-
Pour déconnecter un utilisateur en tant qu’administrateur
L’exemple
admin-user-global-sign-outsuivant déconnecte l’utilisateur diego@example.com.aws cognito-idp admin-user-global-sign-out \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPour plus d’informations, consultez Authentification avec un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AdminUserGlobalSignOut
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserassociate-software-token.
- AWS CLI
-
Pour générer une clé secrète pour une application d’authentification MFA
L’exemple
associate-software-tokensuivant génère une clé privée TOTP pour un utilisateur qui s’est connecté et a reçu un jeton d’accès. La clé privée qui en résulte peut être saisie manuellement dans une application d’authentification, ou les applications peuvent la restituer sous forme de code QR que l’utilisateur peut scanner.aws cognito-idp associate-software-token \ --access-tokeneyJra456defEXAMPLESortie :
{ "SecretCode": "QWERTYUIOP123456EXAMPLE" }Pour plus d’informations, consultez Authentification MFA par jeton logiciel TOTP dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous AssociateSoftwareToken
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserchange-password.
- AWS CLI
-
Pour modifier un mot de passe
Cet exemple modifie un mot de passe.
Commande :
aws cognito-idp change-password --previous-passwordOldPassword--proposed-passwordNewPassword--access-tokenACCESS_TOKEN-
Pour plus de détails sur l'API, reportez-vous ChangePassword
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserconfirm-device.
- AWS CLI
-
Pour confirmer l’appareil d’un utilisateur
L’exemple
confirm-devicesuivant ajoute un nouvel appareil mémorisé pour l’utilisateur actuel.aws cognito-idp confirm-device \ --access-tokeneyJra456defEXAMPLE\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\ --device-secret-verifier-configPasswordVerifier=TXlWZXJpZmllclN0cmluZw,Salt=TXlTUlBTYWx0Sortie :
{ "UserConfirmationNecessary": false }Pour plus d’informations, consultez Utilisation d’appareils utilisateur dans votre groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ConfirmDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserconfirm-forgot-password.
- AWS CLI
-
Pour confirmer un mot de passe oublié
Cet exemple confirme un mot de passe oublié pour le nom d’utilisateur diego@example.com.
Commande :
aws cognito-idp confirm-forgot-password --client-id3n4b5urk1ft4fl3mg5e62d9ado--username=diego@example.com --passwordPASSWORD--confirmation-codeCONF_CODE-
Pour plus de détails sur l'API, reportez-vous ConfirmForgotPassword
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserconfirm-sign-up.
- AWS CLI
-
Pour confirmer l’inscription
Cet exemple confirme l’inscription pour le nom d’utilisateur diego@example.com.
Commande :
aws cognito-idp confirm-sign-up --client-id3n4b5urk1ft4fl3mg5e62d9ado--username=diego@example.com --confirmation-codeCONF_CODE-
Pour plus de détails sur l'API, reportez-vous ConfirmSignUp
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-group.
- AWS CLI
-
Pour créer un groupe
Cet exemple crée un groupe avec une description.
Commande :
aws cognito-idp create-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyNewGroup--description"New group."Sortie :
{ "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }Pour créer un groupe doté d’un rôle et d’une priorité
Cet exemple crée un groupe avec une description. Il inclut également un rôle et une priorité.
Commande :
aws cognito-idp create-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyNewGroupWithRole--description"New group with a role."--role-arnarn:aws:iam::111111111111:role/MyNewGroupRole--precedence2Sortie :
{ "Group": { "GroupName": "MyNewGroupWithRole", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group with a role.", "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", "Precedence": 2, "LastModifiedDate": 1548270211.761, "CreationDate": 1548270211.761 } }-
Pour plus de détails sur l'API, reportez-vous CreateGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-identity-provider.
- AWS CLI
-
Exemple 1 : pour créer un fournisseur d’identité (IdP) SAML de groupe d’utilisateurs avec une URL de métadonnées
L’exemple
create-identity-providersuivant crée un nouvel IdP SAML avec des métadonnées provenant d’une URL publique, un mappage d’attributs et deux identifiants.aws cognito-idp create-identity-provider \ --user-pool-idus-west-2_EXAMPLE\ --provider-nameMySAML\ --provider-typeSAML\ --provider-detailsIDPInit=true,IDPSignout=true,EncryptedResponses=true,MetadataURL=https://auth.example.com/sso/saml/metadata,RequestSigningAlgorithm=rsa-sha256\ --attribute-mappingemail=emailaddress,phone_number=phone,custom:111=department\ --idp-identifiersCorpSAMLWestSAMLSortie :
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "MIICvTCCAaEXAMPLE", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }, "AttributeMapping": { "custom:111": "department", "emailaddress": "email", "phone": "phone_number" }, "IdpIdentifiers": [ "CorpSAML", "WestSAML" ], "LastModifiedDate": 1726853833.977, "CreationDate": 1726853833.977 } }Pour plus d’informations, consultez Ajout de la connexion du groupe d’utilisateurs via un tiers dans le Guide du développeur Amazon Cognito.
Exemple 2 : pour créer un fournisseur d’identité (IdP) SAML de groupe d’utilisateurs avec un fichier de métadonnées
L’exemple
create-identity-providersuivant crée un nouvel IdP SAML avec des métadonnées provenant d’un fichier, un mappage d’attributs et deux identifiants. La syntaxe du fichier peut varier d’un système d’exploitation à l’autre dans le paramètre--provider-details. Il est plus simple de créer un fichier d’entrée JSON pour cette opération :aws cognito-idp create-identity-provider \ --cli-input-json file://.\SAML-identity-provider.jsonContenu de
SAML-identity-provider.json:{ "AttributeMapping": { "email" : "idp_email", "email_verified" : "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "ProviderDetails": { "MetadataFile": "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"http://www.example.com/sso\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>[IDP_CERTIFICATE_DATA]</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/slo/saml\"/><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/slo/saml\"/><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/sso/saml\"/><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/sso/saml\"/></md:IDPSSODescriptor></md:EntityDescriptor>", "IDPSignout" : "true", "RequestSigningAlgorithm" : "rsa-sha256", "EncryptedResponses" : "true", "IDPInit" : "true" }, "ProviderName": "MySAML2", "ProviderType": "SAML", "UserPoolId": "us-west-2_EXAMPLE" }Sortie :
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML2", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[USER_POOL_ENCRYPTION_CERTIFICATE_DATA]", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataFile": "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"http://www.example.com/sso\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>[IDP_CERTIFICATE_DATA]</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/slo/saml\"/><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/slo/saml\"/><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/sso/saml\"/><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/sso/saml\"/></md:IDPSSODescriptor></md:EntityDescriptor>", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://www.example.com/slo/saml", "SSORedirectBindingURI": "https://www.example.com/sso/saml" }, "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "LastModifiedDate": 1726855290.731, "CreationDate": 1726855290.731 } }Pour plus d’informations, consultez Ajout de la connexion du groupe d’utilisateurs via un tiers dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous CreateIdentityProvider
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-resource-server.
- AWS CLI
-
Pour créer un client de groupe d’utilisateurs
L’exemple
create-resource-serversuivant crée un nouveau serveur de ressources avec des portées personnalisées.aws cognito-idp create-resource-server \ --user-pool-idus-west-2_EXAMPLE\ --identifiersolar-system-data\ --name"Solar system object tracker"\ --scopes ScopeName=sunproximity.read,ScopeDescription="Distance in AU from Sol" ScopeName=asteroids.add,ScopeDescription="Enter a new asteroid"Sortie :
{ "ResourceServer": { "UserPoolId": "us-west-2_EXAMPLE", "Identifier": "solar-system-data", "Name": "Solar system object tracker", "Scopes": [ { "ScopeName": "sunproximity.read", "ScopeDescription": "Distance in AU from Sol" }, { "ScopeName": "asteroids.add", "ScopeDescription": "Enter a new asteroid" } ] } }Pour plus d'informations, consultez les sections Scopes, M2M et APIs avec serveurs de ressources dans le manuel Amazon Cognito Developer Guide.
-
Pour plus de détails sur l'API, reportez-vous CreateResourceServer
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-user-import-job.
- AWS CLI
-
Pour créer une tâche d’importation d’utilisateurs
Cet exemple crée une tâche d'importation utilisateur nommée MyImportJob.
Pour plus d’informations sur l’importation des utilisateurs, consultez Importation d’utilisateurs dans des groupes d’utilisateurs via un fichier CSV.
Commande :
aws cognito-idp create-user-import-job --user-pool-idus-west-2_aaaaaaaaa--job-nameMyImportJob--cloud-watch-logs-role-arnarn:aws:iam::111111111111:role/CognitoCloudWatchLogsRoleSortie :
{ "UserImportJob": { "JobName": "MyImportJob", "JobId": "import-qQ0DCt2fRh", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271795.471, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }Téléchargez le fichier .csv avec curl à l’aide de l’URL pré-signée :
Commande :
curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"-
Pour plus de détails sur l'API, reportez-vous CreateUserImportJob
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-user-pool-client.
- AWS CLI
-
Pour créer un client de groupe d’utilisateurs
L'
create-user-pool-clientexemple suivant crée un nouveau client de groupe d'utilisateurs avec un secret client, des attributs de lecture et d'écriture explicites, une connexion avec un nom d'utilisateur-mot de passe et des flux SRP, une connexion avec trois, un accès à un sous-ensemble de champs d'application IdPs, des PinPoint analyses et une durée de OAuth validité de session d'authentification étendue.aws cognito-idp create-user-pool-client \ --user-pool-idus-west-2_EXAMPLE\ --client-nameMyTestClient\ --generate-secret \ --refresh-token-validity10\ --access-token-validity60\ --id-token-validity60\ --token-validity-unitsAccessToken=minutes,IdToken=minutes,RefreshToken=days\ --read-attributesemailphone_numberemail_verifiedphone_number_verified\ --write-attributesemailphone_number\ --explicit-auth-flowsALLOW_USER_PASSWORD_AUTHALLOW_USER_SRP_AUTHALLOW_REFRESH_TOKEN_AUTH\ --supported-identity-providersGoogleFacebookMyOIDC\ --callback-urlshttps://www.amazon.comhttps://example.comhttp://localhost:8001myapp://example\ --allowed-o-auth-flowscodeimplicit\ --allowed-o-auth-scopesopenidprofileaws.cognito.signin.user.adminsolar-system-data/asteroids.add\ --allowed-o-auth-flows-user-pool-client \ --analytics-configurationApplicationArn=arn:aws:mobiletargeting:us-west-2:767671399759:apps/thisisanexamplepinpointapplicationid,UserDataShared=TRUE\ --prevent-user-existence-errorsENABLED\ --enable-token-revocation \ --enable-propagate-additional-user-context-data \ --auth-session-validity4Sortie :
{ "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "MyTestClient", "ClientId": "123abc456defEXAMPLE", "ClientSecret": "this1234is5678my91011example1213client1415secret", "LastModifiedDate": 1726788459.464, "CreationDate": 1726788459.464, "RefreshTokenValidity": 10, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "email_verified", "phone_number_verified", "phone_number", "email" ], "WriteAttributes": [ "phone_number", "email" ], "ExplicitAuthFlows": [ "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "MyOIDC", "Facebook" ], "CallbackURLs": [ "https://example.com", "https://www.amazon.com", "myapp://example", "http://localhost:8001" ], "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile", "solar-system-data/asteroids.add" ], "AllowedOAuthFlowsUserPoolClient": true, "AnalyticsConfiguration": { "ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/thisisanexamplepinpointapplicationid", "RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/cognito-idp.amazonaws.com/AWSServiceRoleForAmazonCognitoIdp", "UserDataShared": true }, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": true, "AuthSessionValidity": 4 } }Pour plus d’informations, consultez Paramètres spécifiques à l’application avec des clients de l’application dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous CreateUserPoolClient
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-user-pool-domain.
- AWS CLI
-
Exemple 1 : pour créer un domaine de groupe d’utilisateurs
L’exemple
create-user-pool-domainsuivant crée un nouveau nom de domaine personnalisé.aws cognito-idp create-user-pool-domain \ --user-pool-idus-west-2_EXAMPLE\ --domainauth.example.com\ --custom-domain-configCertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222Sortie :
{ "CloudFrontDomain": "example1domain.cloudfront.net" }Pour plus d’informations, consultez Configuration d’un domaine de groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
Exemple 2 : pour créer un domaine de groupe d’utilisateurs
L’exemple
create-user-pool-domainsuivant crée un nouveau domaine avec un préfixe appartenant au service.aws cognito-idp create-user-pool-domain \ --user-pool-idus-west-2_EXAMPLE2\ --domainmydomainprefixPour plus d’informations, consultez Configuration d’un domaine de groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous CreateUserPoolDomain
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisercreate-user-pool.
- AWS CLI
-
Pour créer un groupe d’utilisateurs configuré de manière minimale
Cet exemple crée un groupe d'utilisateurs nommé à MyUserPool l'aide des valeurs par défaut. Il n’y a aucun attribut obligatoire ni aucun client d’application. La MFA et la sécurité avancée sont désactivés.
Commande :
aws cognito-idp create-user-pool --pool-nameMyUserPoolSortie :
{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547833345.777, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": {}, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "CreationDate": 1547833345.777, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }Pour créer un groupe d’utilisateurs avec deux attributs requis
Cet exemple crée un groupe d'utilisateurs MyUserPool. Le groupe est configuré pour accepter l’e-mail en tant qu’attribut de nom d’utilisateur. Il définit également l’adresse e-mail source sur une adresse validée à l’aide d’Amazon Simple Email Service.
Commande :
aws cognito-idp create-user-pool --pool-nameMyUserPool--username-attributes"email"--email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"Sortie :
{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547837788.189, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "jane@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" }, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UsernameAttributes": [ "email" ], "CreationDate": 1547837788.189, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }-
Pour plus de détails sur l'API, reportez-vous CreateUserPool
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-group.
- AWS CLI
-
Pour supprimer un groupe
Cet exemple supprime un groupe.
Commande :
aws cognito-idp delete-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroupName-
Pour plus de détails sur l'API, reportez-vous DeleteGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-identity-provider.
- AWS CLI
-
Pour supprimer un fournisseur d’identité
Cet exemple supprime un fournisseur d’identité.
Commande :
aws cognito-idp delete-identity-provider --user-pool-idus-west-2_aaaaaaaaa--provider-nameFacebook-
Pour plus de détails sur l'API, reportez-vous DeleteIdentityProvider
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-resource-server.
- AWS CLI
-
Pour supprimer un serveur de ressources
Cet exemple supprime un serveur de ressources nommé weather.example.com.
Commande :
aws cognito-idp delete-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.com-
Pour plus de détails sur l'API, reportez-vous DeleteResourceServer
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-user-attributes.
- AWS CLI
-
Pour supprimer un attribut utilisateur
L’exemple
delete-user-attributessuivant supprime l’attribut personnalisé « custom:attribute » de l’utilisateur actuellement connecté.aws cognito-idp delete-user-attributes \ --access-tokenACCESS_TOKEN\ --user-attribute-names"custom:department"Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Utilisation d’attributs utilisateur dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous DeleteUserAttributes
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-user-pool-client.
- AWS CLI
-
Pour supprimer un client du groupe d’utilisateurs
Cet exemple supprime un client du groupe d’utilisateurs.
Commande :
aws cognito-idp delete-user-pool-client --user-pool-idus-west-2_aaaaaaaaa--client-id38fjsnc484p94kpqsnet7mpld0-
Pour plus de détails sur l'API, reportez-vous DeleteUserPoolClient
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-user-pool-domain.
- AWS CLI
-
Pour supprimer un domaine du groupe d’utilisateurs
L’exemple
delete-user-pool-domainsuivant supprime un domaine du groupe d’utilisateurs nommémy-domain.aws cognito-idp delete-user-pool-domain \ --user-pool-idus-west-2_aaaaaaaaa\ --domainmy-domain-
Pour plus de détails sur l'API, reportez-vous DeleteUserPoolDomain
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-user-pool.
- AWS CLI
-
Pour supprimer un du groupe d’utilisateurs
Cet exemple supprime un groupe d’utilisateurs à l’aide de l’identifiant du groupe d’utilisateurs us-west-2_aaaaaaaaa.
Commande :
aws cognito-idp delete-user-pool --user-pool-idus-west-2_aaaaaaaaa-
Pour plus de détails sur l'API, reportez-vous DeleteUserPool
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-user.
- AWS CLI
-
Pour supprimer un utilisateur
Cet exemple supprime un utilisateur.
Commande :
aws cognito-idp delete-user --access-tokenACCESS_TOKEN-
Pour plus de détails sur l'API, reportez-vous DeleteUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-identity-provider.
- AWS CLI
-
Pour décrire un fournisseur d’identité
Cet exemple décrit un fournisseur d’identité nommé Facebook.
Commande :
aws cognito-idp describe-identity-provider --user-pool-idus-west-2_aaaaaaaaa--provider-nameFacebookSortie :
{ "IdentityProvider": { "UserPoolId": "us-west-2_aaaaaaaaa", "ProviderName": "Facebook", "ProviderType": "Facebook", "ProviderDetails": { "attributes_url": "https://graph.facebook.com/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": myscope", "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", "client_id": "11111", "client_secret": "11111", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" }, "AttributeMapping": { "username": "id" }, "IdpIdentifiers": [], "LastModifiedDate": 1548105901.736, "CreationDate": 1548105901.736 } }-
Pour plus de détails sur l'API, reportez-vous DescribeIdentityProvider
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-resource-server.
- AWS CLI
-
Pour décrire un serveur de ressources
Cet exemple décrit le serveur de ressources weather.example.com.
Commande :
aws cognito-idp describe-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.comSortie :
{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Weather", "Scopes": [ { "ScopeName": "weather.update", "ScopeDescription": "Update weather forecast" }, { "ScopeName": "weather.read", "ScopeDescription": "Read weather forecasts" }, { "ScopeName": "weather.delete", "ScopeDescription": "Delete a weather forecast" } ] } }-
Pour plus de détails sur l'API, reportez-vous DescribeResourceServer
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-risk-configuration.
- AWS CLI
-
Pour décrire une configuration de risque
Cet exemple décrit la configuration des risques associée au groupe us-west-2_aaaaaaaaa.
Commande :
aws cognito-idp describe-risk-configuration --user-pool-idus-west-2_aaaaaaaaaSortie :
{ "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_IN", "SIGN_UP", "PASSWORD_CHANGE" ], "Actions": { "EventAction": "BLOCK" } }, "AccountTakeoverRiskConfiguration": { "NotifyConfiguration": { "From": "diego@example.com", "ReplyTo": "diego@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", "BlockEmail": { "Subject": "Blocked sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "MfaEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" } }, "Actions": { "LowAction": { "Notify": true, "EventAction": "NO_ACTION" }, "MediumAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" }, "HighAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" } } } } }-
Pour plus de détails sur l'API, reportez-vous DescribeRiskConfiguration
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-user-import-job.
- AWS CLI
-
Pour décrire une tâche d’importation d’utilisateurs
Cet exemple décrit une tâche d’importation d’utilisateurs.
Pour plus d’informations sur l’importation des utilisateurs, consultez Importation d’utilisateurs dans des groupes d’utilisateurs via un fichier CSV.
Commande :
aws cognito-idp describe-user-import-job --user-pool-idus-west-2_aaaaaaaaa--job-idimport-TZqNQvDRnWSortie :
{ "UserImportJob": { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED URL", "CreationDate": 1548271708.512, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }-
Pour plus de détails sur l'API, reportez-vous DescribeUserImportJob
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-user-pool-client.
- AWS CLI
-
Pour décrire un client du groupe d’utilisateurs
Cet exemple décrit un client du groupe d’utilisateurs.
Commande :
aws cognito-idp describe-user-pool-client --user-pool-idus-west-2_aaaaaaaaa--client-id38fjsnc484p94kpqsnet7mpld0Sortie :
{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyApp", "ClientId": "38fjsnc484p94kpqsnet7mpld0", "ClientSecret": "CLIENT_SECRET", "LastModifiedDate": 1548108676.163, "CreationDate": 1548108676.163, "RefreshTokenValidity": 30, "ReadAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "email_verified", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "phone_number_verified", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "WriteAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "ExplicitAuthFlows": [ "ADMIN_NO_SRP_AUTH", "USER_PASSWORD_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } }-
Pour plus de détails sur l'API, reportez-vous DescribeUserPoolClient
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-user-pool-domain.
- AWS CLI
-
Pour décrire un client du groupe d’utilisateurs
Cet exemple décrit un domaine du groupe d’utilisateurs nommé my-domain.
Commande :
aws cognito-idp describe-user-pool-domain --domainmy-domainSortie :
{ "DomainDescription": { "UserPoolId": "us-west-2_aaaaaaaaa", "AWSAccountId": "111111111111", "Domain": "my-domain", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", "Version": "20190128175402", "Status": "ACTIVE", "CustomDomainConfig": {} } }-
Pour plus de détails sur l'API, reportez-vous DescribeUserPoolDomain
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-user-pool.
- AWS CLI
-
Pour décrire un groupe d’utilisateurs
L’exemple suivant décrit un groupe d’utilisateurs dont l’identifiant est us-west-2_EXAMPLE.
aws cognito-idp describe-user-pool \ --user-pool-idus-west-2_EXAMPLESortie :
{ "UserPool": { "Id": "us-west-2_EXAMPLE", "Name": "MyUserPool", "Policies": { "PasswordPolicy": { "MinimumLength": 8, "RequireUppercase": true, "RequireLowercase": true, "RequireNumbers": true, "RequireSymbols": true, "TemporaryPasswordValidityDays": 1 } }, "DeletionProtection": "ACTIVE", "LambdaConfig": { "PreSignUp": "arn:aws:lambda:us-west-2:123456789012:function:MyPreSignUpFunction", "CustomMessage": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomMessageFunction", "PostConfirmation": "arn:aws:lambda:us-west-2:123456789012:function:MyPostConfirmationFunction", "PreAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPreAuthenticationFunction", "PostAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPostAuthenticationFunction", "DefineAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyDefineAuthChallengeFunction", "CreateAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyCreateAuthChallengeFunction", "VerifyAuthChallengeResponse": "arn:aws:lambda:us-west-2:123456789012:function:MyVerifyAuthChallengeFunction", "PreTokenGeneration": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction", "UserMigration": "arn:aws:lambda:us-west-2:123456789012:function:MyMigrateUserFunction", "PreTokenGenerationConfig": { "LambdaVersion": "V2_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction" }, "CustomSMSSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomSMSSenderFunction" }, "CustomEmailSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomEmailSenderFunction" }, "KMSKeyID": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }, "LastModifiedDate": 1726784814.598, "CreationDate": 1602103465.273, "SchemaAttributes": [ { "Name": "sub", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": false, "Required": true, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" } }, { "Name": "name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "given_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "family_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "middle_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "nickname", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "preferred_username", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "profile", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "picture", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "website", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": true, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "gender", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "birthdate", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" } }, { "Name": "zoneinfo", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "locale", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "address", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "updated_at", "AttributeDataType": "Number", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "NumberAttributeConstraints": { "MinValue": "0" } }, { "Name": "identities", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": {} }, { "Name": "custom:111", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "256" } }, { "Name": "dev:custom:222", "AttributeDataType": "String", "DeveloperOnlyAttribute": true, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "421" } }, { "Name": "custom:accesstoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } }, { "Name": "custom:idtoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } } ], "AutoVerifiedAttributes": [ "email" ], "SmsVerificationMessage": "Your verification code is {####}. ", "EmailVerificationMessage": "Your verification code is {####}. ", "EmailVerificationSubject": "Your verification code", "VerificationMessageTemplate": { "SmsMessage": "Your verification code is {####}. ", "EmailMessage": "Your verification code is {####}. ", "EmailSubject": "Your verification code", "EmailMessageByLink": "Please click the link below to verify your email address. <b>{##Verify Your Email##}</b>\n this is from us-west-2_ywDJHlIfU", "EmailSubjectByLink": "Your verification link", "DefaultEmailOption": "CONFIRM_WITH_LINK" }, "SmsAuthenticationMessage": "Your verification code is {####}. ", "UserAttributeUpdateSettings": { "AttributesRequireVerificationBeforeUpdate": [] }, "MfaConfiguration": "OPTIONAL", "DeviceConfiguration": { "ChallengeRequiredOnNewDevice": true, "DeviceOnlyRememberedOnUserPrompt": false }, "EstimatedNumberOfUsers": 166, "EmailConfiguration": { "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com", "EmailSendingAccount": "DEVELOPER" }, "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/userpool-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" }, "UserPoolTags": {}, "Domain": "myCustomDomain", "CustomDomain": "auth.example.com", "AdminCreateUserConfig": { "AllowAdminCreateUserOnly": false, "UnusedAccountValidityDays": 1, "InviteMessageTemplate": { "SMSMessage": "Your username is {username} and temporary password is {####}. ", "EmailMessage": "Your username is {username} and temporary password is {####}. ", "EmailSubject": "Your temporary password" } }, "UserPoolAddOns": { "AdvancedSecurityMode": "ENFORCED", "AdvancedSecurityAdditionalFlows": {} }, "Arn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE", "AccountRecoverySetting": { "RecoveryMechanisms": [ { "Priority": 1, "Name": "verified_email" } ] } } }Pour plus d’informations sur les Groupes d’utilisateurs Amazon Cognito, veuillez consulter le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous DescribeUserPool
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserforget-device.
- AWS CLI
-
Pour oublier un appareil
Cet exemple oublie un appareil.
Commande :
aws cognito-idp forget-device --device-keyus-west-2_abcd_1234-5678-
Pour plus de détails sur l'API, reportez-vous ForgetDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserforgot-password.
- AWS CLI
-
Pour forcer la modification d’un mot de passe
L’exemple
forgot-passwordsuivant envoie un message à jane@example.com pour modifier son mot de passe.aws cognito-idp forgot-password --client-id38fjsnc484p94kpqsnet7mpld0--usernamejane@example.comSortie :
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }-
Pour plus de détails sur l'API, reportez-vous ForgotPassword
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-csv-header.
- AWS CLI
-
Pour créer un en-tête CSV
Cet exemple crée un en-tête CSV.
Pour plus d’informations sur l’importation des utilisateurs, consultez Importation d’utilisateurs dans des groupes d’utilisateurs via un fichier CSV.
Commande :
aws cognito-idp get-csv-header --user-pool-idus-west-2_aaaaaaaaaSortie :
{ "UserPoolId": "us-west-2_aaaaaaaaa", "CSVHeader": [ "name", "given_name", "family_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "email", "email_verified", "gender", "birthdate", "zoneinfo", "locale", "phone_number", "phone_number_verified", "address", "updated_at", "cognito:mfa_enabled", "cognito:username" ] }... Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un fichier CSV : https://docs.aws.amazon.com/cognito/ latest/developerguide/cognito - user-pools-using-import -tool.html
-
Pour plus de détails sur l'API, reportez-vous GetCsvHeader
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-device.
- AWS CLI
-
Pour obtenir un appareil
L’exemple
get-devicesuivant affiche un appareil pour l’utilisateur actuellement connecté.aws cognito-idp get-device \ --access-tokeneyJra456defEXAMPLE\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Sortie :
{ "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } }Pour plus d’informations, consultez Utilisation d’appareils utilisateur dans votre groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetDevice
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-group.
- AWS CLI
-
Pour obtenir des informations sur un groupe
L’exemple
get-groupsuivant répertorie les propriétés du groupe d’utilisateurs nomméMyGroup. Ce groupe a une priorité et un rôle IAM qui lui sont associés.aws cognito-idp get-group \ --user-pool-idus-west-2_EXAMPLE\ --group-nameMyGroupSortie :
{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_EXAMPLE", "RoleArn": "arn:aws:iam::123456789012:role/example-cognito-role", "Precedence": 7, "LastModifiedDate": 1697211218.305, "CreationDate": 1611685503.954 } }Pour plus d’informations, consultez Ajout de groupes à un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-identity-provider-by-identifier.
- AWS CLI
-
Pour obtenir la configuration d’un fournisseur d’identité à partir de l’identifiant IdP
L’exemple
get-identity-provider-by-identifiersuivant renvoie la configuration du fournisseur d’identité avec l’identifiantmysso.aws cognito-idp get-identity-provider-by-identifier \ --user-pool-idus-west-2_EXAMPLE\ --idp-identifiermyssoSortie :
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MYSAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[Certificate contents]", "IDPSignout": "false", "MetadataURL": "https://auth.example.com/saml/metadata/", "SLORedirectBindingURI": "https://auth.example.com/saml/logout/", "SSORedirectBindingURI": "https://auth.example.com/saml/assertion/" }, "AttributeMapping": { "email": "email" }, "IdpIdentifiers": [ "mysso", "mysamlsso" ], "LastModifiedDate": 1705616729.188, "CreationDate": 1643734622.919 } }Pour plus d’informations, consultez Connexion d’un fournisseur d’identité tiers dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetIdentityProviderByIdentifier
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-log-delivery-configuration.
- AWS CLI
-
Pour afficher la configuration de livraison des journaux
L’exemple
get-log-delivery-configurationsuivant affiche les paramètres d’exportation du journal du groupe d’utilisateurs demandé.aws cognito-idp get-log-delivery-configuration \ --user-pool-idus-west-2_EXAMPLESortie :
{ "LogDeliveryConfiguration": { "UserPoolId": "us-west-2_EXAMPLE", "LogConfigurations": [ { "LogLevel": "INFO", "EventSource": "userAuthEvents", "FirehoseConfiguration": { "StreamArn": "arn:aws:firehose:us-west-2:123456789012:deliverystream/my-test-deliverystream" } }, { "LogLevel": "ERROR", "EventSource": "userNotification", "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:my-message-delivery-logs" } } ] } }Pour plus d’informations, consultez Exportation des journaux des groupes d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetLogDeliveryConfiguration
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-signing-certificate.
- AWS CLI
-
Pour afficher le certificat de signature SAML
L’exemple
get-signing-certificatesuivant affiche le certificat de signature SAML 2.0 pour le groupe d’utilisateurs de la demande.aws cognito-idp get-signing-certificate \ --user-pool-idus-west-2_EXAMPLESortie :
{ "Certificate": "[Certificate content]" }Pour plus d’informations, consultez Signature et chiffrement SAML dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetSigningCertificate
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-ui-customization.
- AWS CLI
-
Pour afficher les paramètres classiques de personnalisation de l’interface utilisateur hébergée pour un client d’application
L’exemple
get-ui-customizationsuivant affiche les paramètres classiques de personnalisation de l’interface utilisateur hébergée pour un client d’application qui n’hérite pas des paramètres du groupe d’utilisateurs.aws cognito-idp get-ui-customization \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789Sortie :
{ "UICustomization": { "UserPoolId": "us-west-2_EXAMPLE", "ClientId": "1example23456789", "ImageUrl": "https://example.cloudfront.net/us-west-2_EXAMPLE/1example23456789/20250115191928/assets/images/image.jpg", "CSS": "\n.logo-customizable {\n max-width: 80%;\n max-height: 30%;\n}\n\n.banner-customizable {\n padding: 25px 0px 25px 0px;\n background-color: lightgray;\n}\n\n.label-customizable {\n font-weight: 400;\n}\n\n.textDescription-customizable {\n padding-top: 100px;\n padding-bottom: 10px;\n display: block;\n font-size: 12px;\n}\n\n.idpDescription-customizable {\n padding-top: 10px;\n padding-bottom: 10px;\n display: block;\n font-size: 16px;\n}\n\n.legalText-customizable {\n color: #747474;\n font-size: 11px;\n}\n\n.submitButton-customizable {\n font-size: 14px;\n font-weight: bold;\n margin: 20px 0px 10px 0px;\n height: 50px;\n width: 100%;\n color: #fff;\n background-color: #337ab7;\n}\n\n.submitButton-customizable:hover {\n color: #fff;\n background-color: #286090;\n}\n\n.errorMessage-customizable {\n padding: 5px;\n font-size: 12px;\n width: 100%;\n background: #F5F5F5;\n border: 2px solid #D64958;\n color: #D64958;\n}\n\n.inputField-customizable {\n width: 100%;\n height: 34px;\n color: #555;\n background-color: #fff;\n border: 1px solid #ccc;\n}\n\n.inputField-customizable:focus {\n border-color: #66afe9;\n outline: 0;\n}\n\n.idpButton-customizable {\n height: 40px;\n width: 100%;\n width: 100%;\n text-align: center;\n margin-bottom: 15px;\n color: #fff;\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n\n.idpButton-customizable:hover {\n color: #fff;\n background-color: #31b0d5;\n}\n\n.socialButton-customizable {\n border-radius: 2px;\n height: 60px;\n margin-bottom: 15px;\n padding: 1px;\n text-align: left;\n width: 100%;\n}\n\n.redirect-customizable {\n text-align: center;\n}\n\n.passwordCheck-notValid-customizable {\n color: #DF3312;\n}\n\n.passwordCheck-valid-customizable {\n color: #19BF00;\n}\n\n.background-customizable {\n background-color: #fff;\n}\n", "CSSVersion": "20250115191928" } }Pour plus d’informations, consultez Marquage des interfaces utilisateur hébergées (classique) dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetUiCustomization
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-user-attribute-verification-code.
- AWS CLI
-
Pour envoyer un code de vérification d’attribut à l’utilisateur actuel
L’exemple
get-user-attribute-verification-codesuivant envoie un code de vérification d’attribut à l’adresse e-mail de l’utilisateur actuellement connecté.aws cognito-idp get-user-attribute-verification-code \ --access-tokeneyJra456defEXAMPLE\ --attribute-nameemailSortie :
{ "CodeDeliveryDetails": { "Destination": "a***@e***", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }Pour plus d’informations, consultez Inscription et confirmation de comptes utilisateur dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetUserAttributeVerificationCode
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-user-auth-factors.
- AWS CLI
-
Pour répertorier les facteurs d’authentification disponibles pour l’utilisateur actuel
L’exemple
get-user-auth-factorssuivant répertorie les facteurs d’authentification disponibles pour l’utilisateur actuellement connecté.aws cognito-idp get-user-auth-factors \ --access-tokeneyJra456defEXAMPLESortie :
{ "Username": "testuser", "ConfiguredUserAuthFactors": [ "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN" ] }Pour plus d’informations, consultez Authentification dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetUserAuthFactors
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-user-pool-mfa-config.
- AWS CLI
-
Pour afficher l'authentification multifactorielle et WebAuthn les paramètres d'un groupe d'utilisateurs
L'
get-user-pool-mfa-configexemple suivant montre le MFA et la WebAuthn configuration du groupe d'utilisateurs demandé.aws cognito-idp get-user-pool-mfa-config \ --user-pool-idus-west-2_EXAMPLESortie :
{ "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/my-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } }Pour plus d’informations, consultez Ajout de l’authentification MFA dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetUserPoolMfaConfig
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserget-user.
- AWS CLI
-
Pour obtenir les détails de l’utilisateur actuel
L’exemple
get-usersuivant affiche le profil de l’utilisateur actuellement connecté.aws cognito-idp get-user \ --access-tokeneyJra456defEXAMPLESortie :
{ "Username": "johndoe", "UserAttributes": [ { "Name": "sub", "Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "identities", "Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]" }, { "Name": "email_verified", "Value": "true" }, { "Name": "custom:state", "Value": "Maine" }, { "Name": "name", "Value": "John Doe" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+12065551212" }, { "Name": "preferred_username", "Value": "jamesdoe" }, { "Name": "locale", "Value": "EMEA" }, { "Name": "email", "Value": "jamesdoe@example.com" } ] }Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GetUser
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserglobal-sign-out.
- AWS CLI
-
Pour déconnecter l’utilisateur actuel
L’exemple
global-sign-outsuivant déconnecte l’utilisateur actuel.aws cognito-idp global-sign-out \ --access-tokeneyJra456defEXAMPLECette commande ne produit aucune sortie.
Pour plus d’informations, consultez Gestion des utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous GlobalSignOut
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserinitiate-auth.
- AWS CLI
-
Pour connecter un utilisateur
L’exemple
initiate-authsuivant connecte un utilisateur avec le flux de base nom d’utilisateur/mot de passe, sans difficulté supplémentaire.aws cognito-idp initiate-auth \ --auth-flowUSER_PASSWORD_AUTH\ --client-id1example23456789\ --analytics-metadataAnalyticsEndpointId=d70b2ba36a8c4dc5a04a0451aEXAMPLE\ --auth-parametersUSERNAME=testuser,PASSWORD=[Password]--user-context-dataEncodedData=mycontextdata--client-metadataMyTestKey=MyTestValueSortie :
{ "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } }Pour plus d’informations, consultez Authentification dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous InitiateAuth
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-devices.
- AWS CLI
-
Pour répertorier les appareils d’un utilisateur
L’exemple
list-devicessuivant répertorie les appareils enregistrés par l’utilisateur actuel.aws cognito-idp list-devices \ --access-tokeneyJra456defEXAMPLESortie :
{ "Devices": [ { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "Dart-device" }, { "Name": "last_ip_used", "Value": "192.0.2.1" } ], "DeviceCreateDate": 1715100742.022, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceLastAuthenticatedDate": 1715100742.0, "DeviceLastModifiedDate": 1723233651.167 }, { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "last_ip_used", "Value": "192.0.2.2" } ], "DeviceCreateDate": 1726856147.993, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "DeviceLastAuthenticatedDate": 1726856147.0, "DeviceLastModifiedDate": 1726856147.993 } ] }Pour plus d’informations, consultez Utilisation des appareils dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListDevices
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-groups.
- AWS CLI
-
Pour répertorier les groupes d’un groupe d’utilisateurs
L’exemple
list-groupssuivant répertorie les deux premiers groupes du groupe d’utilisateurs demandé.aws cognito-idp list-groups \ --user-pool-idus-west-2_EXAMPLE\ --max-items2Sortie :
{ "Groups": [ { "CreationDate": 1681760899.633, "Description": "My test group", "GroupName": "testgroup", "LastModifiedDate": 1681760899.633, "Precedence": 1, "UserPoolId": "us-west-2_EXAMPLE" }, { "CreationDate": 1642632749.051, "Description": "Autogenerated group for users who sign in using Facebook", "GroupName": "us-west-2_EXAMPLE_Facebook", "LastModifiedDate": 1642632749.051, "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" }Pour plus d’informations, consultez Ajout de groupes à un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListGroups
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-identity-providers.
- AWS CLI
-
Pour répertorier des fournisseurs d’identité
L’exemple
list-identity-providerssuivant répertorie les deux premiers fournisseurs d’identité du groupe d’utilisateurs demandé.aws cognito-idp list-identity-providers \ --user-pool-idus-west-2_EXAMPLE\ --max-items2Sortie :
{ "Providers": [ { "CreationDate": 1619477386.504, "LastModifiedDate": 1703798328.142, "ProviderName": "Azure", "ProviderType": "SAML" }, { "CreationDate": 1642698776.175, "LastModifiedDate": 1642699086.453, "ProviderName": "LoginWithAmazon", "ProviderType": "LoginWithAmazon" } ], "NextToken": "[Pagination token]" }Pour plus d’informations, consultez Connexion d’un fournisseur d’identité tiers dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListIdentityProviders
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-resource-servers.
- AWS CLI
-
Pour répertorier les serveurs de ressources
L’exemple
list-resource-serverssuivant répertorie les deux premiers serveurs de ressources du groupe d’utilisateurs demandé.aws cognito-idp list-resource-servers \ --user-pool-idus-west-2_EXAMPLE\ --max-results2Sortie :
{ "ResourceServers": [ { "Identifier": "myapi.example.com", "Name": "Example API with custom access control scopes", "Scopes": [ { "ScopeDescription": "International customers", "ScopeName": "international.read" }, { "ScopeDescription": "Domestic customers", "ScopeName": "domestic.read" } ], "UserPoolId": "us-west-2_EXAMPLE" }, { "Identifier": "myapi2.example.com", "Name": "Another example API for access control", "Scopes": [ { "ScopeDescription": "B2B customers", "ScopeName": "b2b.read" } ], "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" }Pour plus d’informations, consultez Contrôle de l’accès aux serveurs de ressources dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListResourceServers
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-tags-for-resource.
- AWS CLI
-
Pour répertorier les balises du groupe d’utilisateurs
L’exemple
list-tags-for-resourcesuivant répertorie les balises attribuées au groupe d’utilisateurs avec l’ARN demandé.aws cognito-idp list-tags-for-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLESortie :
{ "Tags": { "administrator": "Jie", "tenant": "ExampleCorp" } }Pour plus d’informations, consultez Identification des ressources Amazon Cognito dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListTagsForResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-user-import-jobs.
- AWS CLI
-
Pour répertorier les tâches et les statuts d’importation des utilisateurs
L’exemple
list-user-import-jobssuivant répertorie les trois premières tâches d’importation des utilisateurs et leurs détails dans le groupe d’utilisateurs demandé.aws cognito-idp list-user-import-jobs \ --user-pool-idus-west-2_EXAMPLE\ --max-results3Sortie :
{ "PaginationToken": "us-west-2_EXAMPLE#import-example3#1667948397084", "UserImportJobs": [ { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1735329786.142, "CompletionMessage": "The user import job has expired.", "CreationDate": 1735241621.022, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-example1", "JobName": "Test-import-job-1", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "Status": "Expired", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1681509058.408, "CompletionMessage": "Too many users have failed or been skipped during the import.", "CreationDate": 1681509001.477, "FailedUsers": 1, "ImportedUsers": 0, "JobId": "import-example2", "JobName": "Test-import-job-2", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1681509057.965, "Status": "Failed", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1.667864578676E9, "CompletionMessage": "Import Job Completed Successfully.", "CreationDate": 1.667864480281E9, "FailedUsers": 0, "ImportedUsers": 6, "JobId": "import-example3", "JobName": "Test-import-job-3", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1.667864578167E9, "Status": "Succeeded", "UserPoolId": "us-west-2_EXAMPLE" } ] }Pour plus d’informations, consultez Importation des utilisateurs depuis un fichier CSV dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListUserImportJobs
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-user-pool-clients.
- AWS CLI
-
Pour répertorier les clients de l’application
L’exemple
list-user-pool-clientssuivant répertorie les trois premiers clients de l’application du groupe d’utilisateurs demandé.aws cognito-idp list-user-pool-clients \ --user-pool-idus-west-2_EXAMPLE\ --max-results3Sortie :
{ "NextToken": "[Pagination token]", "UserPoolClients": [ { "ClientId": "1example23456789", "ClientName": "app-client-1", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "2example34567890", "ClientName": "app-client-2", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "3example45678901", "ClientName": "app-client-3", "UserPoolId": "us-west-2_EXAMPLE" } ] }Pour plus d’informations, consultez Clients d’application dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListUserPoolClients
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-user-pools.
- AWS CLI
-
Pour afficher les groupes d’utilisateurs
L'
list-user-poolsexemple suivant répertorie 3 des groupes d'utilisateurs disponibles dans le AWS compte des informations d'identification CLI actuelles.aws cognito-idp list-user-pools \ --max-results3Sortie :
{ "NextToken": "[Pagination token]", "UserPools": [ { "CreationDate": 1681502497.741, "Id": "us-west-2_EXAMPLE1", "LambdaConfig": { "CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGenerationConfig": { "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "LambdaVersion": "V1_0" } }, "LastModifiedDate": 1681502497.741, "Name": "user pool 1" }, { "CreationDate": 1686064178.717, "Id": "us-west-2_EXAMPLE2", "LambdaConfig": { }, "LastModifiedDate": 1686064178.873, "Name": "user pool 2" }, { "CreationDate": 1627681712.237, "Id": "us-west-2_EXAMPLE3", "LambdaConfig": { "UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" }, "LastModifiedDate": 1678486942.479, "Name": "user pool 3" } ] }Pour plus d’informations sur les Groupes d’utilisateurs Amazon Cognito, veuillez consulter le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListUserPools
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-users-in-group.
- AWS CLI
-
Pour répertorier les utilisateurs d’un groupe
Cet exemple répertorie les utilisateurs dans un groupe MyGroup.
Commande :
aws cognito-idp list-users-in-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroupSortie :
{ "Users": [ { "Username": "acf10624-80bb-401a-ac61-607bee2110ec", "Attributes": [ { "Name": "sub", "Value": "acf10624-80bb-401a-ac61-607bee2110ec" }, { "Name": "custom:CustomAttr1", "Value": "New Value!" }, { "Name": "email", "Value": "jane@example.com" } ], "UserCreateDate": 1548102770.284, "UserLastModifiedDate": 1548103204.893, "Enabled": true, "UserStatus": "CONFIRMED" }, { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } ] }-
Pour plus de détails sur l'API, reportez-vous ListUsersInGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-users.
- AWS CLI
-
Exemple 1 : pour répertorier les utilisateurs à l’aide d’un filtre côté serveur
L’exemple
list-userssuivant répertorie 3 utilisateurs du groupe d’utilisateurs demandé dont les adresses e-mail commencent partestuser.aws cognito-idp list-users \ --user-pool-idus-west-2_EXAMPLE\ --filter email^=\"testuser\" \ --max-items3Sortie :
{ "PaginationToken": "efgh5678EXAMPLE", "Users": [ { "Attributes": [ { "Name": "sub", "Value": "eaad0219-2117-439f-8d46-4db20e59268f" }, { "Name": "email", "Value": "testuser@example.com" } ], "Enabled": true, "UserCreateDate": 1682955829.578, "UserLastModifiedDate": 1689030181.63, "UserStatus": "CONFIRMED", "Username": "testuser" }, { "Attributes": [ { "Name": "sub", "Value": "3b994cfd-0b07-4581-be46-3c82f9a70c90" }, { "Name": "email", "Value": "testuser2@example.com" } ], "Enabled": true, "UserCreateDate": 1684427979.201, "UserLastModifiedDate": 1684427979.201, "UserStatus": "UNCONFIRMED", "Username": "testuser2" }, { "Attributes": [ { "Name": "sub", "Value": "5929e0d1-4c34-42d1-9b79-a5ecacfe66f7" }, { "Name": "email", "Value": "testuser3@example.com" } ], "Enabled": true, "UserCreateDate": 1684427823.641, "UserLastModifiedDate": 1684427823.641, "UserStatus": "UNCONFIRMED", "Username": "testuser3@example.com" } ] }Pour plus d’informations, consultez Gestion et recherche d’utilisateurs dans le Guide du développeur Amazon Cognito.
Exemple 2 : pour répertorier les utilisateurs à l’aide d’un filtre côté client
L’exemple
list-userssuivant répertorie les attributs de trois utilisateurs dont un attribut, en l’occurrence leur adresse e-mail, contient le domaine de messagerie « @example.com ». Si d’autres attributs contenaient cette chaîne, ils seraient également affichés. Le second utilisateur n’a aucun attribut correspondant à la requête et est exclu de la sortie affichée, mais pas de la réponse du serveur.aws cognito-idp list-users \ --user-pool-idus-west-2_EXAMPLE\ --max-items3--query Users\[\*\].Attributes\[\?Value\.contains\(\@\,\'@example.com\'\)\]Sortie :
[ [ { "Name": "email", "Value": "admin@example.com" } ], [], [ { "Name": "email", "Value": "operator@example.com" } ] ]Pour plus d’informations, consultez Gestion et recherche d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListUsers
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserlist-web-authn-credentials.
- AWS CLI
-
Pour répertorier les informations d’identification par clé d’accès
L'
list-web-authn-credentialsexemple suivant répertorie les clés d'accès ou les informations WebAuthn d'identification de l'utilisateur actuel. Il a un appareil enregistré.aws cognito-idp list-web-authn-credentials \ --access-tokeneyJra456defEXAMPLESortie :
{ "Credentials": [ { "AuthenticatorAttachment": "cross-platform", "CreatedAt": 1736293876.115, "CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "FriendlyCredentialName": "Roaming passkey", "RelyingPartyId": "auth.example.com" } ] }Pour plus d’informations, consultez Connexion par clé d’accès dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ListWebAuthnCredentials
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserresend-confirmation-code.
- AWS CLI
-
Pour renvoyer un code de confirmation
L’exemple
resend-confirmation-codesuivant envoie un code de confirmation à l’utilisateurjane.aws cognito-idp resend-confirmation-code \ --client-id12a3b456c7de890f11g123hijk\ --usernamejaneSortie :
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }Pour plus d’informations, consultez Inscription et confirmation de comptes utilisateur dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous ResendConfirmationCode
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserrespond-to-auth-challenge.
- AWS CLI
-
Exemple 1 : pour répondre à un défi NEW_PASSWORD_REQUIRED
L’exemple
respond-to-auth-challengesuivant répond à un défi NEW_PASSWORD_REQUIRED renvoyé par initiate-auth. Il définit un mot de passe pour l’utilisateurjane@example.com.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789\ --challenge-nameNEW_PASSWORD_REQUIRED\ --challenge-responsesUSERNAME=jane@example.com,NEW_PASSWORD=[Password]\ --sessionAYABeEv5HklEXAMPLESortie :
{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-wt2ha1Zd" } } }Pour plus d’informations, consultez Authentification dans le Guide du développeur Amazon Cognito.
Exemple 2 : pour répondre à un défi SELECT_MFA_TYPE
L’exemple
respond-to-auth-challengesuivant choisit l’authentification MFA par TOTP comme option MFA pour l’utilisateur actuel. L’utilisateur a été invité à sélectionner un type d’authentification MFA et sera ensuite invité à saisir son code MFA.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789--sessionAYABeEv5HklEXAMPLE--challenge-nameSELECT_MFA_TYPE--challenge-responsesUSERNAME=testuser,ANSWER=SOFTWARE_TOKEN_MFASortie :
{ "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeEv5HklEXAMPLE", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "transparent" } }Pour plus d’informations, consultez Ajout de l’authentification MFA dans le Guide du développeur Amazon Cognito.
Exemple 3 : pour répondre à un défi SOFTWARE_TOKEN_MFA
L’exemple
respond-to-auth-challengesuivant fournit un code d’authentification MFA par TOTP et termine la connexion.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789\ --sessionAYABeEv5HklEXAMPLE\ --challenge-nameSOFTWARE_TOKEN_MFA\ --challenge-responsesUSERNAME=testuser,SOFTWARE_TOKEN_MFA_CODE=123456Sortie :
{ "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } }Pour plus d’informations, consultez Ajout de l’authentification MFA dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous RespondToAuthChallenge
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserrevoke-token.
- AWS CLI
-
Pour révoquer un jeton d’actualisation
revoke-tokenci-dessous révoque le jeton d’actualisation demandé et les jetons d’accès associés.aws cognito-idp revoke-token \ --tokeneyJjd123abcEXAMPLE\ --client-id1example23456789Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Révocation de jetons dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous RevokeToken
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-log-delivery-configuration.
- AWS CLI
-
Pour configurer l’exportation des journaux à partir d’un groupe d’utilisateurs
L’exemple
set-log-delivery-configurationsuivant configure le groupe d’utilisateurs demandé en journalisant les erreurs de notification utilisateur dans un groupe de journaux et en journalisant les informations d’authentification utilisateur dans un compartiment S3.aws cognito-idp set-log-delivery-configuration \ --user-pool-idus-west-2_EXAMPLE\ --log-configurationsLogLevel=ERROR,EventSource=userNotification,CloudWatchLogsConfiguration={LogGroupArn=arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported}LogLevel=INFO,EventSource=userAuthEvents,S3Configuration={BucketArn=arn:aws:s3:::amzn-s3-demo-bucket1}Sortie :
{ "LogDeliveryConfiguration": { "LogConfigurations": [ { "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported" }, "EventSource": "userNotification", "LogLevel": "ERROR" }, { "EventSource": "userAuthEvents", "LogLevel": "INFO", "S3Configuration": { "BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1" } } ], "UserPoolId": "us-west-2_EXAMPLE" } }Pour plus d’informations, consultez Exportation des journaux des groupes d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous SetLogDeliveryConfiguration
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-risk-configuration.
- AWS CLI
-
Pour définir la configuration du risque de protection contre les menaces
L’exemple
set-risk-configurationsuivant configure les messages et les actions de protection contre les menaces, les informations d’identification compromises et les exceptions d’adresse IP dans le client d’application demandé. En raison de la complexité de l' NotifyConfiguration objet, la saisie JSON est une bonne pratique pour cette commande.aws cognito-idp set-risk-configuration \ --cli-input-jsonfile://set-risk-configuration.jsonContenu de
set-risk-configuration.json:{ "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" }Sortie :
{ "RiskConfiguration": { "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" } }Pour plus d’informations, consultez Protection contre les menaces dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous SetRiskConfiguration
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-ui-customization.
- AWS CLI
-
Exemple 1 : pour personnaliser l’interface utilisateur hébergée classique d’un client d’application
L’exemple
set-ui-customizationsuivant configure le client d’application demandé avec du CSS personnalisé et avec le logo Amazon Cognito comme logo de l’application.aws cognito-idp set-ui-customization \ --user-pool-idus-west-2_ywDJHlIfU\ --client-id14pq32c5q2uq2q7keorloqvb23\ --css".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n"\ --image-fileiVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCCSortie :
{ "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } }Exemple 2 : pour définir la personnalisation de l’interface utilisateur par défaut pour tous les clients d’application
L’exemple
set-ui-customizationsuivant configure le groupe d’utilisateurs demandé pour tous les clients d’application qui n’ont pas de configuration spécifique au client. La commande applique un CSS personnalisé et utilise le logo Amazon Cognito comme logo de l’application.aws cognito-idp set-ui-customization \ --user-pool-idus-west-2_ywDJHlIfU\ --client-idALL\ --css".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n"\ --image-fileiVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCCSortie :
{ "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } }Pour plus d’informations, consultez Marquage des interfaces utilisateur hébergées (classique) dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous SetUiCustomization
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-user-mfa-preference.
- AWS CLI
-
Pour définir les préférences d’authentification MFA d’un utilisateur
L’exemple
set-user-mfa-preferencesuivant configure l’utilisateur actuel pour utiliser l’authentification MFA TOTP et désactive tous les autres facteurs d’authentification MFA.aws cognito-idp set-user-mfa-preference \ --access-tokeneyJra456defEXAMPLE\ --software-token-mfa-settingsEnabled=true,PreferredMfa=true\ --sms-mfa-settingsEnabled=false,PreferredMfa=false\ --email-mfa-settingsEnabled=false,PreferredMfa=falseCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Ajout de l’authentification MFA dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous SetUserMfaPreference
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-user-pool-mfa-config.
- AWS CLI
-
Pour configurer le MFA du pool d'utilisateurs et WebAuthn
L'
set-user-pool-mfa-configexemple suivant configure le groupe d'utilisateurs demandé avec l'authentification MFA optionnelle avec toutes les méthodes MFA disponibles, et définit la configuration. WebAuthnaws cognito-idp set-user-pool-mfa-config \ --user-pool-idus-west-2_EXAMPLE\ --sms-mfa-configuration "SmsAuthenticationMessage=\"Your OTP for MFA or sign-in: use {####}.\",SmsConfiguration={SnsCallerArn=arn:aws:iam::123456789012:role/service-role/test-SMS-Role,ExternalId=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,SnsRegion=us-west-2}" \ --software-token-mfa-configurationEnabled=true\ --email-mfa-configuration "Message=\"Your OTP for MFA or sign-in: use {####}\",Subject=\"OTP test\"" \ --mfa-configurationOPTIONAL\ --web-authn-configurationRelyingPartyId=auth.example.com,UserVerification=preferredSortie :
{ "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } }Pour plus d’informations, consultez Ajout de l’authentification MFA et Passkey sign-in dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous SetUserPoolMfaConfig
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserset-user-settings.
- AWS CLI
-
Pour définir les paramètres utilisateur
Cet exemple définit la préférence d’obtention de l’authentification MFA sur E-MAIL.
Commande :
aws cognito-idp set-user-settings --access-tokenACCESS_TOKEN--mfa-optionsDeliveryMedium=EMAIL-
Pour plus de détails sur l'API, reportez-vous SetUserSettings
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisersign-up.
- AWS CLI
-
Pour inscrire un utilisateur
Cet exemple inscrit jane@example.com.
Commande :
aws cognito-idp sign-up --client-id3n4b5urk1ft4fl3mg5e62d9ado--usernamejane@example.com--passwordPASSWORD--user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"Sortie :
{ "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" }-
Pour plus de détails sur l'API, reportez-vous SignUp
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserstart-user-import-job.
- AWS CLI
-
Pour démarrer une tâche d’importation
L’exemple
start-user-import-jobsuivant démarre la tâche d’importation demandée dans le groupe d’utilisateurs demandé.aws cognito-idp start-user-import-job \ --user-pool-idus-west-2_EXAMPLE\ --job-idimport-mAgUtd8PMmSortie :
{ "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CreationDate": 1736442975.904, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443020.081, "Status": "Pending", "UserPoolId": "us-west-2_EXAMPLE" } }Pour plus d’informations, consultez Importation d’utilisateurs dans un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous StartUserImportJob
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserstart-web-authn-registration.
- AWS CLI
-
Pour obtenir les informations d’enregistrement par clé d’accès pour un utilisateur connecté
L'
start-web-authn-registrationexemple suivant génère des options WebAuthn d'enregistrement pour l'utilisateur actuel.aws cognito-idp start-web-authn-registration \ --access-tokeneyJra456defEXAMPLESortie :
{ "CredentialCreationOptions": { "authenticatorSelection": { "requireResidentKey": true, "residentKey": "required", "userVerification": "preferred" }, "challenge": "wxvbDicyqQqvF2EXAMPLE", "excludeCredentials": [ { "id": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "type": "public-key" } ], "pubKeyCredParams": [ { "alg": -7, "type": "public-key" }, { "alg": -257, "type": "public-key" } ], "rp": { "id": "auth.example.com", "name": "auth.example.com" }, "timeout": 60000, "user": { "displayName": "testuser", "id": "ZWFhZDAyMTktMjExNy00MzlmLThkNDYtNGRiMjBlNEXAMPLE", "name": "testuser" } } }Pour plus d’informations, consultez Connexion par clé d’accès dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous StartWebAuthnRegistration
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserstop-user-import-job.
- AWS CLI
-
Pour arrêter une tâche d’importation
L’exemple
stop-user-import-jobsuivant arrête la tâche d’importation d’utilisateurs en cours d’exécution demandée dans le groupe d’utilisateurs demandé.aws cognito-idp stop-user-import-job \ --user-pool-idus-west-2_EXAMPLE\ --job-idimport-mAgUtd8PMmSortie :
{ "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CompletionDate": 1736443496.379, "CompletionMessage": "The Import Job was stopped by the developer.", "CreationDate": 1736443471.781, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443494.154, "Status": "Stopped", "UserPoolId": "us-west-2_EXAMPLE" } }Pour plus d’informations, consultez Importation d’utilisateurs dans un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous StopUserImportJob
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utilisertag-resource.
- AWS CLI
-
Pour baliser un groupe d’utilisateurs
L’exemple
tag-resourcesuivant applique des balisesadministratoretdepartmentau groupe d’utilisateurs demandé.aws cognito-idp tag-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE\ --tagsadministrator=Jie,tenant=ExampleCorpCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Identification des ressources Amazon Cognito dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous TagResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliseruntag-resource.
- AWS CLI
-
Pour supprimer des balises d’un groupe d’utilisateurs
L’exemple
untag-resourcesuivant supprime des balisesadministratoretdepartmentdu groupe d’utilisateurs demandé.aws cognito-idp untag-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:767671399759:userpool/us-west-2_l5cxwdm2K\ --tag-keysadministratortenantCette commande ne produit aucune sortie.
Pour plus d’informations, consultez Identification des ressources Amazon Cognito dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UntagResource
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-auth-event-feedback.
- AWS CLI
-
Pour mettre à jour les commentaires relatifs aux événements d’authentification
Cet exemple met à jour les commentaires relatifs aux événements d’autorisation. Il marque l’événement comme « valide ».
Commande :
aws cognito-idp update-auth-event-feedback --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--event-idEVENT_ID--feedback-tokenFEEDBACK_TOKEN--feedback-value"Valid"-
Pour plus de détails sur l'API, reportez-vous UpdateAuthEventFeedback
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-device-status.
- AWS CLI
-
Pour mettre à jour le statut de l’appareil
Cet exemple met à jour le statut d’un appareil sur « not_remembered ».
Commande :
aws cognito-idp update-device-status --access-tokenACCESS_TOKEN--device-keyDEVICE_KEY--device-remembered-status"not_remembered"-
Pour plus de détails sur l'API, reportez-vous UpdateDeviceStatus
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-group.
- AWS CLI
-
Pour mettre à jour un groupe
Cet exemple met à jour la description et la priorité de MyGroup.
Commande :
aws cognito-idp update-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroup--description"New description"--precedence2Sortie :
{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New description", "RoleArn": "arn:aws:iam::111111111111:role/MyRole", "Precedence": 2, "LastModifiedDate": 1548800862.812, "CreationDate": 1548097827.125 } }-
Pour plus de détails sur l'API, reportez-vous UpdateGroup
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-identity-provider.
- AWS CLI
-
Pour mettre à jour le fournisseur d’identité d’un groupe d’utilisateurs
L'
update-identity-providerexemple suivant met à jour le fournisseur OIDC « My OIDCId P » dans le groupe d'utilisateurs demandé.aws cognito-idp update-identity-provider \ --cli-input-jsonfile://update-identity-provider.jsonContenu de
update-identity-provider.json:{ "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1.701129701653E9, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1.701129701653E9, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "UserPoolId": "us-west-2_EXAMPLE" }Sortie :
{ "IdentityProvider": { "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1701129701.653, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1736444278.211, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "ProviderType": "OIDC", "UserPoolId": "us-west-2_EXAMPLE" } }Pour plus d’informations, consultez Configuration d’un domaine dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UpdateIdentityProvider
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-managed-login-branding.
- AWS CLI
-
Pour mettre à jour un style de marque de connexion géré
L’exemple
update-managed-login-brandingsuivant met à jour le style de marque du client d’application demandé.aws cognito-idp update-managed-login-branding \ --cli-input-jsonfile://update-managed-login-branding.jsonContenu de
update-managed-login-branding.json:{ "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "ManagedLoginBrandingId": "63f30090-6b1f-4278-b885-2bbb81f8e545", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" }Sortie :
{ "ManagedLoginBranding": { "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "CreationDate": 1732138490.642, "LastModifiedDate": 1732140420.301, "ManagedLoginBrandingId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" } }Pour plus d’informations, consultez Application du marquage aux pages de connexion gérées dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UpdateManagedLoginBranding
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-resource-server.
- AWS CLI
-
Pour mettre à jour un serveur de ressources
Cet exemple met à jour le serveur de ressources Weather. Il ajoute une nouvelle portée.
Commande :
aws cognito-idp update-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.com--nameWeather--scopes ScopeName=NewScope,ScopeDescription="New scope description"Sortie :
{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } }-
Pour plus de détails sur l'API, reportez-vous UpdateResourceServer
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-user-attributes.
- AWS CLI
-
Pour mettre à jour des attributs utilisateur
Cet exemple met à jour l’attribut utilisateur « nickname ».
Commande :
aws cognito-idp update-user-attributes --access-tokenACCESS_TOKEN--user-attributes Name="nickname",Value="Dan"-
Pour plus de détails sur l'API, reportez-vous UpdateUserAttributes
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-user-pool-client.
- AWS CLI
-
Pour mettre à jour un client d’application
L’exemple
update-user-pool-clientsuivant met à jour la configuration du client d’application demandé.aws cognito-idp update-user-pool-client \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --client-namemy-test-app\ --refresh-token-validity30\ --access-token-validity60\ --id-token-validity60\ --token-validity-unitsAccessToken=minutes,IdToken=minutes,RefreshToken=days\ --read-attributes"address""birthdate""email""email_verified""family_name""gender""locale""middle_name""name""nickname""phone_number""phone_number_verified""picture""preferred_username""profile""updated_at""website""zoneinfo"\ --write-attributes"address""birthdate""email""family_name""gender""locale""middle_name""name""nickname""phone_number""picture""preferred_username""profile""updated_at""website""zoneinfo"\ --explicit-auth-flows"ALLOW_ADMIN_USER_PASSWORD_AUTH""ALLOW_CUSTOM_AUTH""ALLOW_REFRESH_TOKEN_AUTH""ALLOW_USER_PASSWORD_AUTH""ALLOW_USER_SRP_AUTH"\ --supported-identity-providers"MySAML""COGNITO""Google"\ --callback-urls"https://www.example.com""https://app2.example.com"\ --logout-urls"https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com""https://example.com/logout"\ --default-redirect-uri"https://www.example.com"\ --allowed-o-auth-flows"code""implicit"\ --allowed-o-auth-scopes"openid""profile""aws.cognito.signin.user.admin"\ --allowed-o-auth-flows-user-pool-client \ --prevent-user-existence-errorsENABLED\ --enable-token-revocation \ --no-enable-propagate-additional-user-context-data \ --auth-session-validity3Sortie :
{ "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "my-test-app", "ClientId": "1example23456789", "LastModifiedDate": "2025-01-31T14:40:12.498000-08:00", "CreationDate": "2023-09-13T16:26:34.408000-07:00", "RefreshTokenValidity": 30, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "website", "zoneinfo", "address", "birthdate", "email_verified", "gender", "profile", "phone_number_verified", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "WriteAttributes": [ "website", "zoneinfo", "address", "birthdate", "gender", "profile", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "ExplicitAuthFlows": [ "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "COGNITO", "MySAML" ], "CallbackURLs": [ "https://www.example.com", "https://app2.example.com" ], "LogoutURLs": [ "https://example.com/logout", "https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com" ], "DefaultRedirectURI": "https://www.example.com", "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile" ], "AllowedOAuthFlowsUserPoolClient": true, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": false, "AuthSessionValidity": 3 } }Pour plus d’informations, consultez Paramètres spécifiques à l’application avec des clients de l’application dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UpdateUserPoolClient
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-user-pool-domain.
- AWS CLI
-
Pour mettre à jour un domaine personnalisé
L’exemple
update-user-pool-domainsuivant configure la version de marque et le certificat pour le domaine personnalisé du groupe d’utilisateurs demandé.aws cognito-idp update-user-pool-domain \ --user-pool-idca-central-1_EXAMPLE\ --domainauth.example.com\ --managed-login-version2\ --custom-domain-configCertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Sortie :
{ "CloudFrontDomain": "example.cloudfront.net", "ManagedLoginVersion": 2 }Pour plus d’informations, consultez Connexion gérée et Configuration d’un domaine dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UpdateUserPoolDomain
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserupdate-user-pool.
- AWS CLI
-
Pour mettre à jour un groupe d’utilisateurs
L’exemple
update-user-poolsuivant modifie un groupe d’utilisateurs avec un exemple de syntaxe pour chacune des options de configuration disponibles. Pour mettre à jour un groupe d’utilisateurs, vous devez spécifier toutes les options précédemment configurées, sinon elles seront réinitialisées à une valeur par défaut.aws cognito-idp update-user-pool --user-pool-idus-west-2_EXAMPLE\ --policies PasswordPolicy=\{MinimumLength=6,RequireUppercase=true,RequireLowercase=true,RequireNumbers=true,RequireSymbols=true,TemporaryPasswordValidityDays=7\} \ --deletion-protectionACTIVE\ --lambda-config PreSignUp="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-presignup-function",PreTokenGeneration="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-pretoken-function" \ --auto-verified-attributes"phone_number""email"\ --verification-message-template \{\"SmsMessage\":\""Your code is {####}"\",\"EmailMessage\":\""Your code is {####}"\",\"EmailSubject\":\""Your verification code"\",\"EmailMessageByLink\":\""Click {##here##} to verify your email address."\",\"EmailSubjectByLink\":\""Your verification link"\",\"DefaultEmailOption\":\"CONFIRM_WITH_LINK\"\} \ --sms-authentication-message "Your code is {####}" \ --user-attribute-update-settings AttributesRequireVerificationBeforeUpdate="email","phone_number" \ --mfa-configuration"OPTIONAL"\ --device-configurationChallengeRequiredOnNewDevice=true,DeviceOnlyRememberedOnUserPrompt=true\ --email-configuration SourceArn="arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",ReplyToEmailAddress="amdin+noreply@example.com",EmailSendingAccount=DEVELOPER,From="admin@amazon.com",ConfigurationSet="test-configuration-set" \ --sms-configuration SnsCallerArn="arn:aws:iam::123456789012:role/service-role/SNS-SMS-Role",ExternalId="12345",SnsRegion="us-west-2" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-tags "Function"="MyMobileGame","Developers"="Berlin" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-add-ons AdvancedSecurityMode="AUDIT" \ --account-recovery-setting RecoveryMechanisms=\[\{Priority=1,Name="verified_email"\},\{Priority=2,Name="verified_phone_number"\}\]Cette commande ne produit aucune sortie.
Pour plus d’informations, consultez Mise à jour de la configuration d’un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous UpdateUserPool
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserverify-software-token.
- AWS CLI
-
Pour confirmer l’enregistrement d’un authentificateur TOTP
L’exemple
verify-software-tokensuivant termine l’enregistrement TOTP pour l’utilisateur actuel.aws cognito-idp verify-software-token \ --access-tokeneyJra456defEXAMPLE\ --user-code123456Sortie :
{ "Status": "SUCCESS" }Pour plus d’informations, consultez Ajout de l’authentification MFA à un groupe d’utilisateurs dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous VerifySoftwareToken
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserverify-user-attribute.
- AWS CLI
-
Pour vérifier une modification d’attribut
L’exemple
verify-user-attributesuivant vérifie une modification apportée à l’attribut e-mail de l’utilisateur actuel.aws cognito-idp verify-user-attribute \ --access-tokeneyJra456defEXAMPLE\ --attribute-nameemail\ --code123456Pour plus d’informations, consultez Configuration de la vérification par e-mail ou par téléphone dans le Guide du développeur Amazon Cognito.
-
Pour plus de détails sur l'API, reportez-vous VerifyUserAttribute
à la section Référence des AWS CLI commandes.
-
