CSV 파일에서 사용자 풀로 사용자 가져오기

외부 자격 증명 스토어가 있고 새 로컬 사용자를 위해 사용자 풀을 준비할 시간이 있는 경우 쉼표로 구분된 값(CSV) 파일에서 대량 사용자 가져오기는 Amazon Cognito 사용자 풀로 마이그레이션하기 위한 저조하고 저렴한 옵션일 수 있습니다. CSV 파일 가져오기는 템플릿 파일을 다운로드 및 채우고 가져오기 작업의 사용자 풀로 파일을 전달하는 프로세스입니다. CSV 가져오기를 사용하여 테스트 사용자를 빠르게 생성할 수 있습니다. 또한 외부 자격 증명 스토어에 대한 읽기 API 요청으로 파일을 프로그래밍 방식으로 채운 다음 세부 정보 및 속성을 파일에 대한 쓰기 작업에 구문 분석할 수 있습니다.

이 가져오기 프로세스는 password를 제외한 모든 사용자 속성의 값을 설정합니다. 암호 가져오기는 지원되지 않습니다. 보안 모범 사례에서는 일반 텍스트는 암호로 사용할 수 없으며, 해시 가져오기는 지원되지 않기 때문입니다. 즉, 사용자가 처음 로그인할 때 암호를 변경해야 합니다. 사용자는 이 방법을 사용하여 가져올 때 RESET_REQUIRED 상태가 됩니다.

를 사용하여 사용자의 암호를 설정할 수 있습니다. AdminSetUserPassword API Permanent 파라미터를 로 설정하는 요청입니다true. CSV 가져오기는 사용자 풀의 청구된 월별 활성 사용자(MAUs)에 기여하지 않습니다. 그러나 암호 재설정 작업은 를 생성합니다MAUs. 즉시 활성화되지 않을 수 있는 많은 수의 사용자를 가져올 때 비용을 관리하려면 사용자가 로그인하고 RESET_REQUIRED 챌린지를 받을 때 새 암호를 입력하도록 애플리케이션을 설정합니다.

CloudWatch 로그 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 로그 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 명령을 사용하여 명령의 응답에서 URL 얻은 미리 서명된 에 사용자 데이터가 포함된 CSV 파일을 업로드합니다create-user-import-job.

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 로그 역할입니다.

사용자 가져오기 작업 나열

사용자 가져오기 작업을 나열하려면 다음 명령을 사용합니다.

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 두 번째 작업 뒤의 문자열은 이 list 명령에 대한 추가 결과가 있음을 나타냅니다. 추가 결과를 나열하려면 다음과 같이 --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"

계정당 한 번에 하나의 가져오기 작업만 활성화할 수 있습니다.

{
    "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는 사용자가 처음 로그인할 때 새 암호를 설정하라는 메시지를 표시합니다.