Exemples d'utilisation du fournisseur d'identité Amazon Cognito AWS CLI - AWS Command Line Interface
Actions

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 montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le 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 String qui nécessite un minimum de 1 caractère et un maximum de 15. Il n'est pas obligatoire.

Commande :

aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"

  • Pour API plus de détails, voir AddCustomAttributesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseradmim-disable-user.

AWS CLI

Pour désactiver un utilisateur

Cet exemple désactive l'utilisateur jane@example.com.

Commande :

aws cognito-idp admin-disable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Pour API plus de détails, voir AdmimDisableUserla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseradmim-enable-user.

AWS CLI

Pour activer un utilisateur

Cet exemple active le nom d'utilisateur jane@example.com.

Commande :

aws cognito-idp admin-enable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Pour API plus de détails, voir AdmimEnableUserla 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-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup

  • Pour API plus de détails, voir AdminAddUserToGroupla 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-id us-west-2_aaaaaaaaa --username jane@example.com

  • Pour API plus de détails, voir AdminConfirmSignUpla 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'admin-create-userexemple suivant 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-id us-west-2_aaaaaaaaa \
    --username diego \
    --user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \
    --message-action SUPPRESS

Sortie :

{
    "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 API plus de détails, voir AdminCreateUserla 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-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1"

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-id us-west-2_aaaaaaaaa --username diego@example.com

  • Pour API plus de détails, voir AdminDeleteUserla 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 le nom d'utilisateur de l'appareil jane@example.com

Commande :

aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678

  • Pour API plus de détails, voir AdminForgetDevicela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseradmin-get-device.

AWS CLI

Pour obtenir un appareil

Cet exemple obtient un appareil pour le nom d'utilisateur jane@example.com

Commande :

aws cognito-idp admin-get-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678

  • Pour API plus de détails, voir AdminGetDevicela 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 des informations sur le nom d’utilisateur jane@example.com.

Commande :

aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

Sortie :

{
  "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 API plus de détails, voir AdminGetUserla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseradmin-initiate-auth.

AWS CLI

Pour initier l’autorisation

Cet exemple initie l'autorisation en utilisant le AUTH flux ADMIN _NO_ SRP _ pour le nom d'utilisateur jane@example.com

La connexion API pour l'authentification basée sur le serveur (ADMIN_NO_ _SRP) doit être activée sur le client. AUTH

Utilisez les informations de session contenues dans la valeur de retour pour appeler admin-respond-to-auth -challenge.

Commande :

aws cognito-idp admin-initiate-auth --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --auth-flow ADMIN_NO_SRP_AUTH --auth-parameters USERNAME=jane@example.com,PASSWORD=password

Sortie :

{
  "ChallengeName": "NEW_PASSWORD_REQUIRED",
  "Session": "SESSION",
  "ChallengeParameters": {
      "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894",
      "requiredAttributes": "[]",
      "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}"
  }
}

  • Pour API plus de détails, voir AdminInitiateAuthla 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

Cet exemple répertorie les appareils pour le nom d'utilisateur jane@example.com.

Commande :

aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

  • Pour API plus de détails, voir AdminListDevicesla 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-id us-west-2_aaaaaaaaa --username diego@example.com

Sortie :

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

L'exemple de code suivant montre comment utiliseradmin-list-user-auth-events.

AWS CLI

Pour répertorier les événements d'autorisation pour un utilisateur

Cet exemple répertorie les événements d'autorisation pour le nom d'utilisateur diego@example.com.

Commande :

aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

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-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup

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-id us-west-2_aaaaaaaaa --username diego@example.com

L'exemple de code suivant montre comment utiliseradmin-set-user-mfa-preference.

AWS CLI

Pour définir les MFA préférences de l'utilisateur

Cet exemple définit la SMS MFA préférence pour le nom d'utilisateur diego@example.com.

Commande :

aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false

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 MFA de livraison pour le nom d'utilisateur diego@example.com surEMAIL.

Commande :

aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL

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 feedback pour un événement d'autorisation identifié par event-id sur Valid.

Commande :

aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid

L'exemple de code suivant montre comment utiliseradmin-update-device-status.

AWS CLI

Pour mettre à jour l'état de l'appareil

Cet exemple définit l'état mémorisé du périphérique identifié par device-key sur not_remembered.

Commande :

aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx  --device-remembered-status not_remembered

L'exemple de code suivant montre comment utiliseradmin-update-user-attributes.

AWS CLI

Pour mettre à jour les 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-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple"

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-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN

  • Pour API plus de détails, voir ChangePasswordla 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-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE

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-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE

  • Pour API plus de détails, voir ConfirmSignUpla 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-id us-west-2_aaaaaaaaa --group-name MyNewGroup --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-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2

Sortie :

{
  "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 API plus de détails, voir CreateGroupla 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 par un utilisateur

Cet exemple crée une tâche d'importation utilisateur nommée MyImportJob.

Pour plus d'informations sur l'importation d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole

Sortie :

{
  "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 en utilisant le présigné : URL

Commande :

curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"

  • Pour API plus de détails, voir CreateUserImportJobla 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

Cet exemple crée un nouveau client de groupe d'utilisateurs avec deux flux d'autorisation explicites : USER _ PASSWORD _ AUTH et ADMIN _NO_ _SRP. AUTH

Commande :

aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa  --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH"

Sortie :

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "MyNewClient",
      "ClientId": "6p3bs000no6a4ue1idruvd05ad",
      "LastModifiedDate": 1548697449.497,
      "CreationDate": 1548697449.497,
      "RefreshTokenValidity": 30,
      "ExplicitAuthFlows": [
          "USER_PASSWORD_AUTH",
          "ADMIN_NO_SRP_AUTH"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

L'exemple de code suivant montre comment utilisercreate-user-pool-domain.

AWS CLI

Pour créer un domaine de groupe d'utilisateurs

Cet exemple crée un nouveau domaine de groupe d'utilisateurs avec deux flux d'autorisation explicites : USER _ _ AUTH et PASSWORD ADMIN SRP _NO_ _. AUTH

Commande :

aws cognito-idp create-user-pool-domain --user-pool-id us-west-2_aaaaaaaaa  --domain my-new-domain

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. MFAet la sécurité avancée est désactivée.

Commande :

aws cognito-idp create-user-pool --pool-name MyUserPool

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": 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-name MyUserPool --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 API plus de détails, voir CreateUserPoolla 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-id us-west-2_aaaaaaaaa  --group-name MyGroupName

  • Pour API plus de détails, voir DeleteGroupla 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-id us-west-2_aaaaaaaaa --provider-name Facebook

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-id us-west-2_aaaaaaaaa --identifier weather.example.com

L'exemple de code suivant montre comment utiliserdelete-user-attributes.

AWS CLI

Pour supprimer les attributs utilisateur

Cet exemple supprime l'attribut utilisateur « FAVORITE _ ANIMAL ».

Commande :

aws cognito-idp delete-user-attributes --access-token ACCESS_TOKEN --user-attribute-names "FAVORITE_ANIMAL"

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-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0

L'exemple de code suivant montre comment utiliserdelete-user-pool-domain.

AWS CLI

Pour supprimer le domaine d'un groupe d'utilisateurs

L'delete-user-pool-domainexemple suivant supprime un domaine de groupe d'utilisateurs nommé my-domain

aws cognito-idp delete-user-pool-domain \
    --user-pool-id us-west-2_aaaaaaaaa \
    --domain my-domain

L'exemple de code suivant montre comment utiliserdelete-user-pool.

AWS CLI

Pour supprimer un 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-id us-west-2_aaaaaaaaa

  • Pour API plus de détails, voir DeleteUserPoolla 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-token ACCESS_TOKEN

  • Pour API plus de détails, voir DeleteUserla 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-id us-west-2_aaaaaaaaa --provider-name Facebook

Sortie :

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

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-id us-west-2_aaaaaaaaa --identifier weather.example.com

Sortie :

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

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 pool us-west-2_aaaaaaaaa.

Commande :

aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa

Sortie :

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

L'exemple de code suivant montre comment utiliserdescribe-user-import-job.

AWS CLI

Pour décrire une tâche d'importation par un utilisateur

Cet exemple décrit une tâche de saisie utilisateur.

Pour plus d'informations sur l'importation d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Sortie :

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

L'exemple de code suivant montre comment utiliserdescribe-user-pool-client.

AWS CLI

Pour décrire un client de groupe d'utilisateurs

Cet exemple décrit un client de groupe d'utilisateurs.

Commande :

aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0

Sortie :

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

L'exemple de code suivant montre comment utiliserdescribe-user-pool-domain.

AWS CLI

Pour décrire un client de groupe d'utilisateurs

Cet exemple décrit un domaine de groupe d'utilisateurs nommé my-domain.

Commande :

aws cognito-idp describe-user-pool-domain --domain my-domain

Sortie :

{
  "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": {}
  }
}

L'exemple de code suivant montre comment utiliserdescribe-user-pool.

AWS CLI

Pour décrire un groupe d'utilisateurs

Cet exemple décrit un groupe d'utilisateurs dont l'identifiant est us-west-2_aaaaaaaaa.

Commande :

aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa

Sortie :

{
  "UserPool": {
      "SmsVerificationMessage": "Your verification code is {####}. ",
      "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": true,
              "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
          }
      ],
      "EmailVerificationSubject": "Your verification code",
      "MfaConfiguration": "OFF",
      "Name": "MyUserPool",
      "EmailVerificationMessage": "Your verification code is {####}. ",
      "SmsAuthenticationMessage": "Your authentication code is {####}. ",
      "LastModifiedDate": 1547763720.822,
      "AdminCreateUserConfig": {
          "InviteMessageTemplate": {
              "EmailMessage": "Your username is {username} and temporary password is {####}. ",
              "EmailSubject": "Your temporary password",
              "SMSMessage": "Your username is {username} and temporary password is {####}. "
          },
          "UnusedAccountValidityDays": 7,
          "AllowAdminCreateUserOnly": false
      },
      "EmailConfiguration": {
          "ReplyToEmailAddress": "myemail@mydomain.com"
          "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com"
      },
      "AutoVerifiedAttributes": [
          "email"
      ],
      "Policies": {
          "PasswordPolicy": {
              "RequireLowercase": true,
              "RequireSymbols": true,
              "RequireNumbers": true,
              "MinimumLength": 8,
              "RequireUppercase": true
          }
      },
      "UserPoolTags": {},
      "UsernameAttributes": [
          "email"
      ],
      "CreationDate": 1547763720.822,
      "EstimatedNumberOfUsers": 1,
      "Id": "us-west-2_aaaaaaaaa",
      "LambdaConfig": {}
  }
}

  • Pour API plus de détails, voir DescribeUserPoolla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserforget-device.

AWS CLI

Pour oublier un appareil

Dans cet exemple, un appareil est oublié.

Commande :

aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678

  • Pour API plus de détails, voir ForgetDevicela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserforgot-password.

AWS CLI

Pour forcer le changement de mot de passe

L'forgot-passwordexemple suivant envoie un message à jane@example.com pour modifier son mot de passe.

aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com

Sortie :

{
    "CodeDeliveryDetails": {
        "Destination": "j***@e***.com",
        "DeliveryMedium": "EMAIL",
        "AttributeName": "email"
    }
}

  • Pour API plus de détails, voir ForgotPasswordla 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 d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa

Sortie :

{
  "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 CSV fichier : https://docs.aws.amazon.com/cognito/ cognito-user-pools-using latest/developerguide/ -import-tool.html

  • Pour API plus de détails, voir GetCsvHeaderla 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

Cet exemple permet d'obtenir des informations sur un groupe nommé MyGroup.

Commande :

aws cognito-idp get-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup

Sortie :

{
  "Group": {
      "GroupName": "MyGroup",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "Description": "A sample group.",
      "LastModifiedDate": 1548270073.795,
      "CreationDate": 1548270073.795
  }
}

  • Pour API plus de détails, voir GetGroupla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-signing-certificate.

AWS CLI

Pour obtenir un certificat de signature

Cet exemple permet d'obtenir un certificat de signature pour un groupe d'utilisateurs.

Commande :

aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa

Sortie :

{
  "Certificate": "CERTIFICATE_DATA"
}

L'exemple de code suivant montre comment utiliserget-ui-customization.

AWS CLI

Pour obtenir des informations sur la personnalisation de l'interface utilisateur

Cet exemple permet d'obtenir des informations de personnalisation de l'interface utilisateur pour un groupe d'utilisateurs.

Commande :

aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa

Sortie :

{
  "UICustomization": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientId": "ALL",
      "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg",
      "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n",
      "CSSVersion": "20190128231240"
  }
}

  • Pour API plus de détails, voir GetUiCustomizationla 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 d'importation effectuées par les utilisateurs

Cet exemple répertorie les tâches d'importation effectuées par les utilisateurs.

Pour plus d'informations sur l'importation d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp list-user-import-jobs --user-pool-id us-west-2_aaaaaaaaa  --max-results 20

Sortie :

{
  "UserImportJobs": [
      {
          "JobName": "Test2",
          "JobId": "import-d0OnwGA3mV",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "PreSignedUrl": "PRE_SIGNED_URL",
          "CreationDate": 1548272793.069,
          "Status": "Created",
          "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
          "ImportedUsers": 0,
          "SkippedUsers": 0,
          "FailedUsers": 0
      },
      {
          "JobName": "Test1",
          "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
      },
      {
          "JobName": "import-Test1",
          "JobId": "import-TZqNQvDRnW",
          "UserPoolId": "us-west-2_aaaaaaaaa",
          "PreSignedUrl": "PRE_SIGNED_URL",
          "CreationDate": 1548271708.512,
          "StartDate": 1548277247.962,
          "CompletionDate": 1548277248.912,
          "Status": "Failed",
          "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
          "ImportedUsers": 0,
          "SkippedUsers": 0,
          "FailedUsers": 1,
          "CompletionMessage": "Too many users have failed or been skipped during the import."
      }
  ]
}

  • Pour API plus de détails, voir ListUserImportJobsla 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

Cet exemple répertorie jusqu’à 20 groupes d’utilisateurs.

Commande :

aws cognito-idp list-user-pools --max-results 20

Sortie :

{
  "UserPools": [
      {
         "CreationDate": 1547763720.822,
         "LastModifiedDate": 1547763720.822,
         "LambdaConfig": {},
         "Id": "us-west-2_aaaaaaaaa",
         "Name": "MyUserPool"
      }
  ]
}

  • Pour API plus de détails, voir ListUserPoolsla 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-id us-west-2_aaaaaaaaa --group-name MyGroup

Sortie :

{
  "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 API plus de détails, voir ListUsersInGroupla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-users.

AWS CLI

Pour afficher les utilisateurs

Cet exemple répertorie jusqu’à 20 utilisateurs.

Commande :

aws cognito-idp list-users --user-pool-id us-west-2_aaaaaaaaa --limit 20

Sortie :

{
  "Users": [
      {
          "Username": "22704aa3-fc10-479a-97eb-2af5806bd327",
          "Enabled": true,
          "UserStatus": "FORCE_CHANGE_PASSWORD",
          "UserCreateDate": 1548089817.683,
          "UserLastModifiedDate": 1548089817.683,
          "Attributes": [
              {
                  "Name": "sub",
                  "Value": "22704aa3-fc10-479a-97eb-2af5806bd327"
              },
              {
                  "Name": "email_verified",
                  "Value": "true"
              },
              {
                  "Name": "email",
                  "Value": "mary@example.com"
              }
          ]
      }
  ]
}

  • Pour API plus de détails, voir ListUsersla 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-code suivant envoie un code de confirmation à l’utilisateur jane.

aws cognito-idp resend-confirmation-code \
    --client-id 12a3b456c7de890f11g123hijk \
    --username jane

Sortie :

{
    "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.

L'exemple de code suivant montre comment utiliserrespond-to-auth-challenge.

AWS CLI

Pour répondre à une stimulation d’authentification

Cet exemple répond à une stimulation d’autorisation lancée avec initiate-auth. C'est une réponse au REQUIRED défi NEW PASSWORD _ _. Elle définit un mot de passe pour l’utilisateur jane@example.com.

Commande :

aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN"

Sortie :

{
  "ChallengeParameters": {},
  "AuthenticationResult": {
      "AccessToken": "ACCESS_TOKEN",
      "ExpiresIn": 3600,
      "TokenType": "Bearer",
      "RefreshToken": "REFRESH_TOKEN",
      "IdToken": "ID_TOKEN",
      "NewDeviceMetadata": {
          "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23",
          "DeviceGroupKey": "-wt2ha1Zd"
      }
  }
}

L'exemple de code suivant montre comment utiliserset-risk-configuration.

AWS CLI

Pour définir la configuration des risques

Cet exemple définit la configuration des risques pour un groupe d'utilisateurs. Il définit l'action de l'événement d'inscription sur ACTION NO_.

Commande :

aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa  --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}

Sortie :

{
  "RiskConfiguration": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "CompromisedCredentialsRiskConfiguration": {
          "EventFilter": [
              "SIGN_UP"
          ],
          "Actions": {
              "EventAction": "NO_ACTION"
          }
      }
  }
}

L'exemple de code suivant montre comment utiliserset-ui-customization.

AWS CLI

Pour configurer la personnalisation de l'interface utilisateur

Cet exemple personnalise le CSS paramètre d'un groupe d'utilisateurs.

Commande :

aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n"

Sortie :

{
  "UICustomization": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientId": "ALL",
      "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n",
      "CSSVersion": "20190129172214"
  }
}

  • Pour API plus de détails, voir SetUiCustomizationla 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 MFA paramètres utilisateur

L'set-user-mfa-preferenceexemple suivant modifie les options de MFA livraison. Cela change le support MFA de livraison enSMS.

aws cognito-idp set-user-mfa-preference \
    --access-token "eyJra12345EXAMPLE" \
    --software-token-mfa-settings Enabled=true,PreferredMfa=true \
    --sms-mfa-settings Enabled=false,PreferredMfa=false

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Ajouter MFA à un groupe d'utilisateurs dans le manuel Amazon Cognito Developer Guide.

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 MFA de livraison surEMAIL.

Commande :

aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL

  • Pour API plus de détails, voir SetUserSettingsla 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-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"

Sortie :

{
  "UserConfirmed": false,
  "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862"
}

  • Pour API plus de détails, voir SignUpla 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 par un utilisateur

Cet exemple démarre une tâche de saisie utilisateur.

Pour plus d'informations sur l'importation d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Sortie :

{
  "UserImportJob": {
      "JobName": "import-Test10",
      "JobId": "import-lmpxSOuIzH",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED_URL",
      "CreationDate": 1548278378.928,
      "StartDate": 1548278397.334,
      "Status": "Pending",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0
  }
}

  • Pour API plus de détails, voir StartUserImportJobla 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 par un utilisateur

Cet exemple arrête une tâche de saisie utilisateur.

Pour plus d'informations sur l'importation d'utilisateurs, voir Importation d'utilisateurs dans des groupes d'utilisateurs à partir d'un CSV fichier.

Commande :

aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

Sortie :

{
  "UserImportJob": {
      "JobName": "import-Test5",
      "JobId": "import-Fx0kARISFL",
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "PreSignedUrl": "PRE_SIGNED_URL",
      "CreationDate": 1548278576.259,
      "StartDate": 1548278623.366,
      "CompletionDate": 1548278626.741,
      "Status": "Stopped",
      "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole",
      "ImportedUsers": 0,
      "SkippedUsers": 0,
      "FailedUsers": 0,
      "CompletionMessage": "The Import Job was stopped by the developer."
  }
}

  • Pour API plus de détails, voir StopUserImportJobla 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. Cela indique que l'événement est « valide ».

Commande :

aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid"

L'exemple de code suivant montre comment utiliserupdate-device-status.

AWS CLI

Pour mettre à jour l'état de l'appareil

Cet exemple met à jour le statut d'un appareil sur « not_remembered ».

Commande :

aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered"

  • Pour API plus de détails, voir UpdateDeviceStatusla 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-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2

Sortie :

{
  "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 API plus de détails, voir UpdateGroupla 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. Cela ajoute une nouvelle portée.

Commande :

aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --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"
          }
      ]
  }
}

L'exemple de code suivant montre comment utiliserupdate-user-attributes.

AWS CLI

Pour mettre à jour les attributs utilisateur

Cet exemple met à jour l'attribut utilisateur « surnom ».

Commande :

aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan"

L'exemple de code suivant montre comment utiliserupdate-user-pool-client.

AWS CLI

Pour mettre à jour un client de groupe d'utilisateurs

Cet exemple met à jour le nom d'un client du groupe d'utilisateurs. Il ajoute également un attribut inscriptible « surnom ».

Commande :

aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname"

Sortie :

{
  "UserPoolClient": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "ClientName": "NewClientName",
      "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado",
      "LastModifiedDate": 1548802761.334,
      "CreationDate": 1548178931.258,
      "RefreshTokenValidity": 30,
      "WriteAttributes": [
          "nickname"
      ],
      "AllowedOAuthFlowsUserPoolClient": false
  }
}

L'exemple de code suivant montre comment utiliserupdate-user-pool.

AWS CLI

Pour mettre à jour un groupe d'utilisateurs

Cet exemple ajoute des balises à un groupe d'utilisateurs.

Commande :

aws cognito-idp update-user-pool --user-pool-id us-west-2_aaaaaaaaa --user-pool-tags Team=Blue,Area=West

  • Pour API plus de détails, voir UpdateUserPoolla section Référence des AWS CLI commandes.