CSV ファイルからユーザープールにユーザーをインポートする

外部 ID ストアがあり、新しいローカルユーザーのためにユーザープールを準備する時間がある場合、カンマ区切り値 (CSV) ファイルからの一括ユーザーインポートは、Amazon Cognito ユーザープールへの移行のための低労力で低コストのオプションになります。CSV ファイルインポートは、テンプレートファイルをダウンロードして入力し、インポートジョブのユーザープールにファイルを渡すプロセスです。CSV インポートを使用して、テストユーザーをすばやく作成できます。また、外部 ID ストアへの読み取りAPIリクエストをプログラムでファイルに入力し、その詳細と属性をファイルへの書き込みオペレーションに解析することもできます。

インポートプロセスは、[パスワード] 以外のすべてのユーザー属性の値を設定します。セキュリティのベストプラクティスでは、パスワードはプレーンテキスト形式として使用できない必要があり、ハッシュのインポートはサポートされていないため、パスワードのインポートはサポートされません。つまり、ユーザーは最初にサインインした際にパスワードを変更する必要があります。このメソッドを使用してインポートすると、ユーザーは RESET_REQUIRED状態になります。

ユーザーのパスワードは、 を使用して設定できます。 AdminSetUserPassword API リクエストは、 Permanentパラメータを に設定しますtrue。CSV インポートは、ユーザープール内の請求された毎月のアクティブユーザー (MAUs) には影響しません。ただし、パスワードリセットオペレーションは を生成しますMAUs。すぐにアクティブでない可能性のある多数のユーザーをインポートする際のコストを管理するには、ユーザーがサインインしてRESET_REQUIREDチャレンジを受け取ったときに新しいパスワードの入力を求めるようにアプリケーションを設定します。

CloudWatch Logs IAMロールの作成

Amazon Cognito CLIまたは を使用している場合はAPI、ロールを作成 CloudWatch IAMする必要があります。次の手順では、Amazon Cognito がインポートジョブの結果を CloudWatch Logs に書き込むために使用できるIAMロールを作成する方法について説明します。

ユーザーインポートCSVファイルの作成

既存のユーザーをユーザープールにインポートする前に、インポートするユーザーとその属性を含むカンマ区切りの値 (CSV) ファイルを作成する必要があります。ユーザープールから、ユーザープールの属性スキーマを反映するヘッダーを含むユーザーインポートファイルを取得できます。その後、CSV ファイルのフォーマット のフォーマット要件に一致するユーザー情報を挿入できます。

CSV ファイルヘッダーのダウンロード (コンソール）

CSV ヘッダーファイルをダウンロードするには、次の手順に従います。

CSV ファイルヘッダーのダウンロード (AWS CLI）

正しいヘッダーのリストを取得するには、次のCLIコマンドを実行します。USER_POOL_ID は、ユーザーをインポートするユーザープールのユーザープール識別子です。

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

レスポンス例:

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

CSV ファイルのフォーマット

ダウンロードしたユーザーインポートCSVヘッダーファイルは、次の文字列のようになります。ユーザープールに追加したカスタム属性も含まれます。

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

CSV ファイルを編集して、このヘッダーとユーザーの属性値が含まれ、次のルールに従ってフォーマットされるようにします。

次のリストは、カスタム属性のないユーザープールのCSVインポートファイルの例です。ユーザープールスキーマは、この例とは異なる場合があります。この場合、ユーザープールからダウンロードするCSVテンプレートにテスト値を指定する必要があります。

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

Amazon Cognito ユーザープールのインポートジョブの作成と実行

このセクションでは、Amazon Cognito コンソールと AWS Command Line Interface () を使用してユーザープールのインポートジョブを作成して実行する方法について説明しますAWS CLI。

CSV ファイルからのユーザーのインポート (コンソール）

次の手順では、 CSV ファイルからユーザーをインポートする方法について説明します。

ユーザーのインポート (AWS CLI)

次のCLIコマンドは、ユーザーをユーザープールにインポートするために使用できます。

これらのコマンドに関するコマンドラインオプションのリストを取得するには、help コマンドラインオプションを使用します。次に例を示します。

aws cognito-idp get-csv-header help

ユーザーインポートジョブの作成

CSV ファイルを作成したら、次のCLIコマンドを実行してユーザーインポートジョブを作成します。JOB_NAME は、ジョブに選択する名前です。USER_POOL_ID は、新しいユーザーを追加するユーザープールのユーザープール ID です。ROLE_ARN は、 でARN受け取ったロールです 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"

- PRE_SIGNED_URL レスポンスで返された は 15 分間有効です。その後、有効期限が切れるため、新しい を取得するには、新しいユーザーインポートジョブを作成する必要がありますURL。

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

ユーザーインポートジョブのステータス値

ユーザーインポートのコマンドに対する応答には、Status を示す次のような値が見つかります。

CSV ファイルのアップロード

次のcurlコマンドを使用して、ユーザーデータを含むCSVファイルをcreate-user-import-job、コマンドのレスポンスからURL取得した署名付きファイルにアップロードします。

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

このコマンドの出力から、次のようなメッセージを見つけます: "We are completely uploaded and fine" このメッセージは、ファイルが正常にアップロードされたことを示します。

ユーザーインポートジョブの説明

ユーザーインポートジョブの説明を取得するには、次のコマンドを使用します。USER_POOL_ID はユーザープール ID であり、JOB_ID は、ユーザーインポートジョブの作成時に返されたジョブ ID です。

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

上記のサンプル出力では、PRE_SIGNED_URL は、CSVファイルをアップロードURLした です。- ROLE_ARN は、ロールの作成時にARN受け取った CloudWatch Logs ロールです。

ユーザーインポートジョブを表示する

ユーザーインポートジョブを一覧表示するには、次のコマンドを使用します:

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

ジョブは時系列で、作成が最後から最初の順で表示されます。- PAGINATION_TOKEN 2 番目のジョブの後の文字列は、このリストコマンドに追加の結果があることを示します。残りの結果を表示するには、次のように --pagination-token オプションを使用します:

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

ユーザーインポートジョブの開始

ユーザーインポートジョブを開始するには、次のコマンドを使用します:

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

インポートジョブは、アカウントごとに 1 つしかアクティブにできません。

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

ユーザーインポートジョブの停止

ユーザーインポートジョブの進行中に停止するには、次のコマンドを使用します。ジョブを停止すると、再開することはできません。

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

CloudWatch コンソールでユーザープールのインポート結果を表示する

インポートジョブの結果は、Amazon CloudWatch コンソールで表示できます。

結果の表示

次のステップでは、ユーザープールのインポートの結果を表示する方法を説明します。

結果の解釈

正常にインポートされたユーザーは、ステータスがPasswordReset「」に設定されています。

次の場合、ユーザーはインポートされませんが、インポートジョブは継続します。

以下の場合、インポートジョブは失敗します。

インポートされたユーザーにパスワードをリセットするように要求

インポートされた各ユーザーが初めてサインインしてパスワードを入力するときは、新しいパスワードを入力する必要があります。次の手順では、CSVファイルをインポートした後のローカルユーザーによるカスタムアプリケーションのユーザーエクスペリエンスについて説明します。ユーザーがホストされた UI でサインインすると、Amazon Cognito はユーザーが最初にサインインしたときに新しいパスワードを設定するように求めます。