Création du fichier CSV d'importation d'utilisateurs - Amazon Cognito

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.

Création du fichier CSV d'importation d'utilisateurs

Avant de pouvoir importer des utilisateurs existants dans votre groupe d'utilisateurs, vous devez d'abord créer un fichier CSV (valeurs séparées par des virgules) contenant les utilisateurs que vous souhaitez importer ainsi que leurs attributs. À partir de votre groupe d'utilisateurs, vous pouvez extraire un fichier d'importation d'utilisateurs dont les en-têtes reflètent le schéma d'attributs de votre groupe d'utilisateurs. Vous pouvez ensuite insérer les informations utilisateur qui répondent aux exigences de mise en forme décrites dans Mise en forme du fichier CSV.

Téléchargement de l'en-tête du fichier CSV (console)

Utilisez la procédure suivante pour télécharger le fichier d'en-tête CSV.

Pour télécharger l'en-tête du fichier CSV
  1. Accédez à la console Amazon Cognito. Il se peut que vous soyez invité à saisir vos informations d'identification AWS.

  2. Choisissez Groupes d'utilisateurs.

  3. Choisissez un groupe d'utilisateurs existant dans la liste.

  4. Sélectionnez l'onglet Utilisateurs.

  5. Dans la section Import users (Importer des utilisateurs), choisissez Create an import job (Créer une tâche d'importation).

  6. Sous Upload CSV (Charger un fichier CSV), sélectionnez le lien template.csv et téléchargez le fichier CSV.

Téléchargement de l'en-tête du fichier CSV (AWS CLI)

Pour obtenir la liste des en-têtes corrects, exécutez la commande de CLI, où USER_POOL_ID est l'identifiant du groupe d'utilisateurs vers lequel vous allez importer les utilisateurs :

aws cognito-idp get-csv-header --user-pool-id "USER_POOL_ID"

Exemple de réponse :

{ "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" ], "UserPoolId": "USER_POOL_ID" }

Mise en forme du fichier CSV

Une fois téléchargé, le fichier d'en-tête CSV d'importation d'utilisateurs ressemble à la chaîne suivante. Il comporte également les attributs personnalisés que vous avez éventuellement ajoutés à votre groupe d'utilisateurs.

cognito:username,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

Modifiez votre fichier CSV de telle sorte qu'il contienne cet en-tête et les valeurs d'attribut pour vos utilisateurs et qu'il soit mis en forme selon les règles suivantes :

Note

Pour plus d'informations sur les valeurs d'attributs, par exemple, un format approprié pour les numéros de téléphone, consultez Attributs de groupe d'utilisateurs.

  • La première ligne du fichier est la ligne d'en-tête téléchargée qui contient les noms des attributs utilisateur.

  • L'ordre des colonnes dans le fichier CSV n'a pas d'importance.

  • Chaque ligne après la première ligne contient les valeurs d'attribut d'un utilisateur.

  • Toutes les colonnes de l'en-tête doivent être présentes, mais vous n'avez pas besoin de fournir des valeurs dans chaque colonne.

  • Les attributs suivants sont obligatoires :

    • cognito:username

    • cognito:mfa_enabled

    • email_verified ou phone_number_verified

      • Au moins l'un des attributs à vérification automatique doit avoir la valeur true pour chaque utilisateur. Un attribut à vérification automatique est une adresse e-mail ou un numéro de téléphone auxquels Amazon Cognito envoie automatiquement un code lorsqu'un nouvel utilisateur rejoint votre groupe d'utilisateurs.

      • Le groupe d'utilisateurs doit avoir au moins un attribut à vérification automatique, que ce soit email_verified ou phone_number_verified. Si le pool d'utilisateurs n'a pas d'attributs à vérification automatique, la tâche d'importation ne démarre pas.

      • Si le pool d'utilisateurs n'a qu'un seul attribut à vérification automatique, cet attribut doit être vérifié pour chaque utilisateur. Par exemple, si le groupe d'utilisateurs n'a que phone_number comme attribut à vérification automatique, la valeur de phone_number_verified doit être true pour chaque utilisateur.

      Note

      Pour pouvoir réinitialiser leur mot de passe, les utilisateurs doivent disposer d'une adresse e-mail ou d'un numéro de téléphone vérifiés. Amazon Cognito envoie un message contenant un code de réinitialisation de mot de passe à l'adresse e-mail ou au numéro de téléphone spécifiés dans le fichier CSV. Si le message est envoyé au numéro de téléphone, il est envoyé par SMS. Pour de plus amples informations, veuillez consulter Vérification des coordonnées à l’inscription.

    • email (si email_verified a la valeur true)

    • phone_number (si phone_number_verified a la valeur true)

    • Tous les attributs que vous avez marqués comme obligatoires lorsque vous avez créé le pool d'utilisateurs

  • Les valeurs d'attribut qui sont des chaînes ne doivent pas être entre guillemets.

  • Si une valeur d'attribut contient une virgule, vous devez placer une barre oblique inverse (\) devant la virgule. La raison en est que les champs au sein d'un fichier CSV sont séparés par des virgules.

  • Le contenu du fichier CSV doit être au format UTF-8 sans marque d'ordre d'octet.

  • Le champ cognito:username est obligatoire et doit être unique au sein de votre groupe d'utilisateurs. Ce peut être n'importe quelle chaîne Unicode. Cependant, elle ne peut pas comporter d'espaces ou de tabulations.

  • La valeur birthdate, si elle est présente, doit être au format mm/jj/aaaa. Cela signifie, par exemple, que la date du 1er février 1985 doit être codée sous la forme 02/01/1985.

  • Le champ cognito:mfa_enabled est obligatoire. Si vous avez défini l'authentification multi-facteur (MFA, Multi-Factor Authentication) comme obligatoire dans votre pool d'utilisateurs, ce champ doit avoir la valeur true pour tous les utilisateurs. Si vous avez désactivé l'authentification MFA, ce champ doit avoir la valeur false pour tous les utilisateurs. Si vous avez défini l'authentification MFA comme facultative, ce champ peut être true ou false, mais ne peut pas être vide.

  • La longueur maximale de la ligne est de 16 000 caractères.

  • La taille maximale du fichier CSV est de 100 Mo.

  • Le nombre maximal de lignes (utilisateurs) du fichier est de 500 000. La ligne d'en-tête n'est pas comprise dans ce nombre maximal.

  • La valeur du champ updated_at doit être une heure Posix exprimée en secondes, par exemple : 1471453471.

  • Les espaces de début ou de fin d'une valeur d'attribut seront supprimés.

La liste suivante est un exemple de fichier d'importation CSV pour un groupe d'utilisateurs sans attributs personnalisés. Le schéma de votre groupe d'utilisateurs peut être différent par rapport à cet exemple. Dans ce cas, vous devez fournir des valeurs de test dans le modèle CSV que vous téléchargez à partir de votre groupe d'utilisateurs.

cognito:username,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 John,,John,Doe,,,,,,,johndoe@example.com,TRUE,,02/01/1985,,,+12345550100,TRUE,123 Any Street,,FALSE Jane,,Jane,Roe,,,,,,,janeroe@example.com,TRUE,,01/01/1985,,,+12345550199,TRUE,100 Main Street,,FALSE