Importazione di utenti in pool di utenti da un file CSV

Se disponi di un archivio di identità esterno e hai tempo a disposizione per preparare il pool di utenti per nuovi utenti locali, l'importazione in blocco di utenti da un file di valori separati da virgole (CSV) può essere un'opzione semplice ed economica per la migrazione a un pool di utenti di Amazon Cognito. L'importazione di un CSV file è un processo di download e compilazione di un file modello, quindi di trasferimento del file al pool di utenti in un processo di importazione. È possibile utilizzare un'CSVimportazione per creare rapidamente utenti di prova. È inoltre possibile compilare il file a livello di codice con API richieste di lettura all'archivio di identità esterno, quindi analizzarne i dettagli e gli attributi in operazioni di scrittura sul file.

Il processo di importazione imposta i valori per tutti gli attributi utente eccetto la password. L'importazione della password non è supportata, poiché le best practice di sicurezza richiedono che le password non siano disponibili come testo normale e noi non supportiamo l'importazione di hash. Questo significa che i tuoi utenti devono cambiare le loro password dopo il primo accesso. Gli utenti sono in uno RESET_REQUIRED stato quando vengono importati con questo metodo.

Puoi impostare le password degli utenti con un AdminSetUserPasswordAPIrichiesta che imposta il Permanent parametro su. true CSVimport non contribuisce agli utenti attivi fatturati mensilmente (MAUs) nel tuo pool di utenti. Tuttavia, le operazioni di reimpostazione della password generano. MAUs Per gestire i costi quando importi un numero elevato di utenti che potrebbero non essere immediatamente attivi, configura l'applicazione in modo che richieda agli utenti una nuova password quando accedono e ricevono la sfida. RESET_REQUIRED

Creazione del ruolo CloudWatch Logs IAM

Se utilizzi Amazon Cognito CLI oppureAPI, devi creare un CloudWatch IAM ruolo. La procedura seguente descrive come creare un IAM ruolo che Amazon Cognito può utilizzare per scrivere i risultati del processo di importazione in Logs. CloudWatch

Creazione del CSV file di importazione utente

Prima di poter importare gli utenti esistenti nel pool di utenti, è necessario creare un file di valori separati da virgole (CSV) che contenga gli utenti che si desidera importare e i relativi attributi. Dal pool di utenti, è possibile recuperare un file di importazione utente con intestazioni che riflettono lo schema di attributi del pool di utenti. È quindi possibile inserire le informazioni utente che soddisfano i requisiti di formattazione in Formattazione del file CSV.

Scaricamento dell'intestazione del CSV file (console)

Utilizzate la seguente procedura per scaricare il file di CSV intestazione.

Scaricamento dell'intestazione CSV del file ()AWS CLI

Per ottenere un elenco delle intestazioni corrette, esegui il seguente CLI comando, dove USER_POOL_ID è l'identificatore del pool di utenti per il pool di utenti in cui importerai gli utenti:

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

Risposta di esempio:

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

Formattazione del file CSV

Il file di CSV intestazione di importazione utente scaricato ha l'aspetto della stringa seguente. Include anche eventuali attributi personalizzati aggiunti al pool di utenti.

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

Modifica il CSV file in modo che includa questa intestazione e i valori degli attributi per gli utenti e sia formattato secondo le seguenti regole:

L'elenco seguente è un esempio di file di CSV importazione per un pool di utenti senza attributi personalizzati. Lo schema del pool di utenti potrebbe differire da questo esempio. In tal caso, è necessario fornire i valori di test nel CSV modello scaricato dal pool di utenti.

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

Creazione ed esecuzione del processo di importazione del bacino d'utenza di Amazon Cognito

Questa sezione descrive come creare ed eseguire il processo di importazione del pool di utenti utilizzando la console Amazon Cognito e AWS Command Line Interface ()AWS CLI.

Importazione di utenti da un CSV file (console)

La procedura seguente descrive come importare gli utenti dal CSV file.

Importazione di utenti (AWS CLI)

I seguenti CLI comandi sono disponibili per importare utenti in un pool di utenti:

Per l'elenco delle opzioni della riga di comando per questi comandi, utilizza l'opzione help della riga di comando. Per esempio:

aws cognito-idp get-csv-header help

Creazione di un processo di importazione degli utenti

Dopo aver creato il CSV file, create un processo di importazione degli utenti eseguendo il CLI comando seguente, dove JOB_NAME è il nome che scegli per il lavoro, USER_POOL_ID è l'ID del pool di utenti per il pool di utenti a cui verranno aggiunti i nuovi utenti e ROLE_ARN è il ruolo ARN che hai ricevuto inCreazione del ruolo CloudWatch Logs IAM:

aws cognito-idp create-user-import-job --job-name "JOB_NAME" --user-pool-id "USER_POOL_ID" --cloud-watch-logs-role-arn "ROLE_ARN"

Il PRE_SIGNED_URL restituito nella risposta è valido per 15 minuti. Trascorso tale periodo, scadrà e sarà necessario creare un nuovo processo di importazione utenti per ottenerne uno nuovoURL.

{
    "UserImportJob": {
        "Status": "Created",
        "SkippedUsers": 0,
        "UserPoolId": "USER_POOL_ID",
        "ImportedUsers": 0,
        "JobName": "JOB_NAME",
        "JobId": "JOB_ID",
        "PreSignedUrl": "PRE_SIGNED_URL",
        "CloudWatchLogsRoleArn": "ROLE_ARN",
        "FailedUsers": 0,
        "CreationDate": 1470957431.965
    }
}

Valori di stato per un processo di importazione degli utenti

Nelle risposte ai comandi di importazione degli utenti, visualizzerai uno dei seguenti valori Status:

Caricamento del file CSV

Usa il seguente curl comando per caricare il CSV file contenente i tuoi dati utente nel prefirmato URL che hai ottenuto dalla risposta del create-user-import-job comando.

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

Nell'output di questo comando, cerca la frase "We are completely uploaded and fine". Questa frase indica che il file è stato caricato correttamente.

Descrizione di un processo di importazione degli utenti

Per ottenere una descrizione del processo di importazione degli utenti, utilizzate il seguente comando, dove USER_POOL_ID è l'ID del tuo pool di utenti e JOB_ID è l'ID del lavoro che è stato restituito quando è stato creato il processo di importazione degli utenti.

aws cognito-idp describe-user-import-job --user-pool-id "USER_POOL_ID" --job-id "JOB_ID"

{
    "UserImportJob": {
        "Status": "Created",
        "SkippedUsers": 0,
        "UserPoolId": "USER_POOL_ID",
        "ImportedUsers": 0,
        "JobName": "JOB_NAME",
        "JobId": "JOB_ID",
        "PreSignedUrl": "PRE_SIGNED_URL",
        "CloudWatchLogsRoleArn":"ROLE_ARN",
        "FailedUsers": 0,
        "CreationDate": 1470957431.965
    }
}

Nell'output di esempio precedente, PRE_SIGNED_URL è il file URL in cui è stato caricato il CSV file. Il ROLE_ARN è il ruolo CloudWatch Logs ARN che hai ricevuto quando hai creato il ruolo.

Elenco dei tuoi processi di importazione degli utenti

Per elencare i tuoi processi di importazione degli utenti, utilizza il comando seguente:

aws cognito-idp list-user-import-jobs --user-pool-id "USER_POOL_ID" --max-results 2

{
    "UserImportJobs": [
        {
            "Status": "Created",
            "SkippedUsers": 0,
            "UserPoolId": "USER_POOL_ID",
            "ImportedUsers": 0,
            "JobName": "JOB_NAME",
            "JobId": "JOB_ID",
            "PreSignedUrl":"PRE_SIGNED_URL",
            "CloudWatchLogsRoleArn":"ROLE_ARN",
            "FailedUsers": 0,
            "CreationDate": 1470957431.965
        },
        {
            "CompletionDate": 1470954227.701,
            "StartDate": 1470954226.086,
            "Status": "Failed",
            "UserPoolId": "USER_POOL_ID",
            "ImportedUsers": 0,
            "SkippedUsers": 0,
            "JobName": "JOB_NAME",
            "CompletionMessage": "Too many users have failed or been skipped during the import.",
            "JobId": "JOB_ID",
            "PreSignedUrl":"PRE_SIGNED_URL",
            "CloudWatchLogsRoleArn":"ROLE_ARN",
            "FailedUsers": 5,
            "CreationDate": 1470953929.313
        }
    ],
    "PaginationToken": "PAGINATION_TOKEN"
}

I processi sono elencati in ordine cronologico dall'ultimo creato al primo. Il PAGINATION_TOKEN la stringa dopo il secondo processo indica che ci sono risultati aggiuntivi per questo comando list. Per elencare i risultati aggiuntivi, utilizza l' opzione --pagination-token come segue:

aws cognito-idp list-user-import-jobs --user-pool-id "USER_POOL_ID" --max-results 10 --pagination-token "PAGINATION_TOKEN"

Avvio di un processo di importazione degli utenti

Per avviare un processo di importazione degli utenti, utilizza il comando seguente:

aws cognito-idp start-user-import-job --user-pool-id "USER_POOL_ID" --job-id "JOB_ID"

Può essere attivo soltanto un processo di importazione alla volta per account.

{
    "UserImportJob": {
        "Status": "Pending",
        "StartDate": 1470957851.483,
        "UserPoolId": "USER_POOL_ID",
        "ImportedUsers": 0,
        "SkippedUsers": 0,
        "JobName": "JOB_NAME",
        "JobId": "JOB_ID",
        "PreSignedUrl":"PRE_SIGNED_URL",
        "CloudWatchLogsRoleArn": "ROLE_ARN",
        "FailedUsers": 0,
        "CreationDate": 1470957431.965
    }
}

Arresto di un processo di importazione degli utenti

Per arrestare un processo di importazione degli utenti mentre è in corso, utilizza il comando seguente. Una volta che hai interrotto il processo, non puoi riavviarlo.

aws cognito-idp stop-user-import-job --user-pool-id "USER_POOL_ID" --job-id "JOB_ID"

{
    "UserImportJob": {
        "CompletionDate": 1470958050.571,
        "StartDate": 1470958047.797,
        "Status": "Stopped",
        "UserPoolId": "USER_POOL_ID",
        "ImportedUsers": 0,
        "SkippedUsers": 0,
        "JobName": "JOB_NAME",
        "CompletionMessage": "The Import Job was stopped by the developer.",
        "JobId": "JOB_ID",
        "PreSignedUrl":"PRE_SIGNED_URL",
        "CloudWatchLogsRoleArn": "ROLE_ARN",
        "FailedUsers": 0,
        "CreationDate": 1470957972.387
    }
}

Visualizzazione dei risultati di importazione del pool di utenti nella CloudWatch console

Puoi visualizzare i risultati del tuo processo di importazione nella CloudWatch console Amazon.

Visualizzazione dei risultati

I seguenti passaggi descrivono come visualizzare i risultati dell'importazione del bacino d'utenza.

Interpretazione dei risultati

Lo stato degli utenti importati con successo è impostato su "PasswordReset».

Nei seguenti casi, l'utente non verrà importato, ma il processo di importazione proseguirà:

Nei seguenti casi, il processo di importazione fallirà:

Necessità degli utenti importati di ripristinare le password

La prima volta che ciascun utente importato esegue l'accesso e inserisce qualsiasi password, deve immettere una nuova password. La procedura seguente descrive l'esperienza utente in un'app personalizzata con utenti locali dopo l'importazione di un CSV file. Se gli utenti accedono con l'interfaccia utente ospitata, Amazon Cognito richiede di impostare una nuova password quando eseguono primo accesso.