Creación del archivo CSV de importación de usuarios

Para poder importar los usuarios existentes a su grupo de usuarios, debe crear un archivo de valores separados por comas (CSV) que contenga los usuarios que desea importar y sus atributos. A partir de su grupo de usuarios, puede recuperar un archivo de importación de usuarios con encabezados que reflejen el esquema de atributos de su grupo de usuarios. A continuación, puede insertar la información de usuario que coincida con los requisitos de formato de Formato del archivo CSV.

Descarga del encabezado del archivo CSV (consola)

Siga este procedimiento para descargar el archivo de encabezado de CSV.

Para descargar el encabezado de archivo CSV

1. Diríjase a la consola de Amazon Cognito. Es posible que se le soliciten sus credenciales de AWS.

2. Elija User Pools (Grupos de usuarios).

3. Elija en la lista un usuario existente.

4. Elija la pestaña Users.

5. En la sección Import users (Importar usuarios), elija Create an import job (Crear un trabajo de importación).

6. En Upload CSV (Cargar CSV), seleccione el enlace template.csv y descargue el archivo CSV.

Descarga del encabezado del archivo CSV (AWS CLI)

Para obtener una lista de los encabezados correctos, ejecute este comando de la CLI, donde USER_POOL_ID es el identificador del grupo de usuarios al que importará los usuarios:

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

Respuesta de ejemplo:

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

Formato del archivo CSV

El archivo de encabezado CSV de importación de usuarios descargado es parecido a la siguiente cadena. También incluye cualquier atributo personalizado que haya agregado a su grupo de usuarios.

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

Edite el archivo CSV para que incluya este encabezado y los valores de atributo de sus usuarios y que tenga un formato que siga estas reglas:

nota

Para obtener más información acerca de los valores de atributos, como el formato adecuado para números de teléfono, consulte Custom pool attributes (.

• La primera línea del archivo es la fila de encabezado descargada, que contiene los nombres de los atributos de usuario.

• El orden de las columnas del archivo CSV no importa.

• Cada línea tras la primera línea contiene los valores de atributo de un usuario.

• Todas las columnas del encabezado tienen que estar presentes, pero no es necesario proporcionar valores para cada columna.

• Los atributos siguientes son obligatorios:

  • cognito:username

  • cognito:mfa_enabled

  • email_verified o phone_number_verified

    • Al menos uno de los atributos verificados automáticamente debe ser true para cada usuario. Un atributo verificado automáticamente es una dirección de correo electrónico o un número de teléfono al que Amazon Cognito envía automáticamente un código cuando un nuevo usuario se une a su grupo de usuarios.

    • El grupo de usuarios debe tener al menos un atributo verificado automáticamente, ya sea email_verified o phone_number_verified. Si el grupo de usuarios no tiene atributos verificados automáticamente, el trabajo de importación no empezará.

    • Si el grupo de usuarios solo tiene un atributo verificado automáticamente, dicho atributo tiene que verificarse para cada usuario. Por ejemplo, si el grupo de usuarios solo tiene phone_number como un atributo verificado automáticamente, el valor phone_number_verified debe ser true para cada usuario.

    nota

    Para que los usuarios restablezcan sus contraseñas, deben tener un correo electrónico o un número de teléfono verificado. Amazon Cognito envía un mensaje con el código de restablecimiento de contraseña al correo electrónico o al número de teléfono especificado en el archivo CSV. Si el mensaje se envía al número de teléfono, se envía mediante SMS. Para obtener más información, consulte Verificación de la información de contacto durante el registro.

  • email (si email_verified es true)

  • phone_number (si phone_number_verified es true)

  • Todos los atributos que ha marcado como obligatorios al crear el grupo de usuarios

• Los valores de atributo que son cadenas no deben estar entre comillas.

• Si un valor de atributo contiene una coma, debe poner delante de la coma una barra oblicua inversa (\). Esto se debe a que los campos de un archivo CSV están separados por comas.

• El contenido del archivo CSV debe estar en formato UTF-8 sin marca de orden de bytes.

• El campo cognito:username es obligatorio y debe ser único dentro del grupo de usuarios. Puede ser cualquier cadena Unicode. Sin embargo, no puede contener espacios ni pestañas.

• Los valores birthdate (Fecha de nacimiento), si los hay, deben tener el formato mm/dd/aaaa. Esto significa, por ejemplo, que la fecha de nacimiento 1 de febrero de 1985 debe codificarse como 02/01/1985.

• El campo cognito:mfa_enabled es obligatorio. Si ha establecido que la autenticación multifactor (MFA) es obligatoria en su grupo de usuarios, este campo debe ser true para todos los usuarios. Si ha desactivado la autenticación MFA, este campo debe ser false para todos los usuarios. Si ha definido la autenticación MFA como opcional, este campo puede ser true o false, pero no puede estar vacío.

• La longitud máxima de la fila es de 16 000 caracteres.

• El tamaño de archivo CSV máximo es de 100 MB.

• El número máximo de filas (usuarios) del archivo es de 500 000. Este máximo no incluye la fila de encabezado.

• Se espera que el valor del campo updated_at (Actualizado a) esté en formato de tiempo Unix en segundos, por ejemplo: 1471453471.

• Los espacios en blanco del principio y del final de un valor de atributo se eliminan.

La siguiente lista es un ejemplo de archivo de importación CSV para un grupo de usuarios sin atributos personalizados. Su esquema de grupo de usuarios puede diferir de este ejemplo. En ese caso, deberá proporcionar valores de prueba en la plantilla CSV que descargue de su grupo de usuarios.

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,,,,,,,[e-mail],TRUE,,02/01/1985,,,[phone],TRUE,123 Any Street,,FALSE
Jane,,Jane,Roe,,,,,,,[e-mail],TRUE,,01/01/1985,,,[phone],TRUE,100 Main Street,,FALSE