사용자 마이그레이션 Lambda 트리거

사용자가 암호로 로그인할 때 사용자 풀에 존재하지 않는 경우 또는 암호 찾기 흐름에 있는 경우 Amazon Cognito에서 이 트리거를 호출합니다. Lambda 함수가 성공적으로 반환된 이후 Amazon Cognito는 사용자를 사용자 풀에 추가합니다. 사용자 마이그레이션 Lambda 트리거를 사용하는 인증 흐름에 대한 자세한 내용은 사용자 마이그레이션 Lambda 트리거를 사용하여 사용자 풀로 사용자 가져오기를 참조하세요.

로그인 시 또는 암호 찾기 흐름 동안 기존 사용자 디렉터리에 있는 사용자를 Amazon Cognito 사용자 풀로 마이그레이션하려면 이 Lambda 트리거를 사용합니다.

사용자 마이그레이션 Lambda 트리거 소스

triggerSource 값	이벤트
UserMigration_Authentication	로그인 시 사용자 마이그레이션입니다.
UserMigration_ForgotPassword	암호 찾기 흐름 도중 사용자 마이그레이션.

사용자 마이그레이션 Lambda 트리거 파라미터

Amazon Cognito가 이 Lambda 함수에 전달하는 요청은 아래 파라미터와 Amazon Cognito가 모든 요청에 추가하는 공통 파라미터의 조합입니다.

JSON

{
    "userName": "string",
    "request": {
        "password": "string",
        "validationData": {
            "string": "string",
            . . .
        },
        "clientMetadata": {
            "string": "string",
      	. . .
        }
    },
    "response": {
        "userAttributes": {
            "string": "string",
            . . .
        },
        "finalUserStatus": "string",
        "messageAction": "string",
        "desiredDeliveryMediums": [ "string", . . .],
        "forceAliasCreation": boolean,
        "enableSMSMFA": boolean
    }
}

사용자 마이그레이션 요청 파라미터

사용자 이름

로그인 시 사용자가 입력하는 사용자 이름입니다.

password

로그인 시 사용자가 입력하는 암호입니다. Amazon Cognito는 암호 찾기 흐름에 의해 시작된 요청에서 이 값을 보내지 않습니다.

validationData

사용자 로그인 요청에 검증 데이터를 포함하는 하나 이상의 키-값 페어입니다. 이 데이터를 Lambda 함수에 전달하려면 InitiateAuth 및 AdminInitiateAuth API 작업에서 ClientMetadata 파라미터를 사용합니다.

clientMetadata

사용자 마이그레이션 트리거를 위한 Lambda 함수에 사용자 지정 입력으로 제공할 수 있는 하나 이상의 키-값 페어입니다. 이 데이터를 Lambda 함수에 전달하려면 AdminRespondToAuthChallenge 및 ForgotPassword API 작업에서 ClientMetadata 파라미터를 사용합니다.

사용자 마이그레이션 응답 파라미터

userAttributes

이 필드는 필수 항목입니다.

이 필드는 Amazon Cognito가 사용자 풀의 사용자 프로필에 저장하고 사용자 속성으로 사용하는 이름-값 페어를 하나 이상 포함해야 합니다. 표준 속성과 사용자 지정 속성을 모두 포함할 수 있습니다. 표준 속성과 구별하기 위해 사용자 지정 속성에 custom: 접두사가 필요합니다. 자세한 내용은 사용자 지정 속성을 참조하세요.

참고

암호 찾기 흐름에서 사용자가 암호를 재설정하려면 확인된 이메일 주소 또는 확인된 전화 번호를 입력해야 합니다. Amazon Cognito는 암호 재설정 코드가 포함된 메시지를 사용자 속성에 있는 이메일 주소 또는 전화 번호로 보냅니다.

Attributes	요구 사항
사용자 풀을 만들 때 필수로 표시한 모든 속성	마이그레이션 중에 필수 속성이 누락된 경우 Amazon Cognito는 기본값을 사용합니다.
username	로그인을 위한 사용자 이름 외에 별칭 속성을 사용하여 사용자 풀을 구성하고, 사용자가 유효한 별칭 값을 사용자 이름으로 입력한 경우 필요합니다. 이 별칭 값은 이메일 주소, 선호하는 사용자 이름 또는 전화 번호일 수 있습니다. 요청 및 사용자 풀이 별칭 요구 사항을 충족하는 경우 함수로부터의 응답은 해당 함수가 수신한 username 파라미터를 별칭 속성에 할당해야 하며 응답은 사용자의 값을 username 속성에 할당해야 합니다. 사용자 풀이 수신된 username을 별칭에 매핑하는 데 필요한 조건을 충족하지 않는 경우 응답의 username 파라미터는 요청과 정확하게 일치하거나 생략되어야 합니다. 참고 username은 사용자 풀에서 고유해야 합니다.

finalUserStatus

사용자가 이전 암호로 로그인할 수 있도록 사용자를 자동 확인하기 위해 이 파라미터를 CONFIRMED로 설정할 수 있습니다. 사용자를 CONFIRMED로 설정하면 해당 사용자는 사전에 추가 작업을 수행하지 않고도 로그인할 수 있습니다. 이 속성을 CONFIRMED로 설정하지 않은 경우 해당 속성이 RESET_REQUIRED로 설정됩니다.

RESET_REQUIRED의 finalUserStatus는 사용자가 로그인 시 마이그레이션 직후에 자신의 암호를 변경해야 하며 클라이언트 앱은 인증 흐름 동안 PasswordResetRequiredException을 처리해야 함을 의미합니다.

참고

Amazon Cognito는 Lambda 트리거를 사용하여 마이그레이션하는 동안 사용자 풀에 대해 구성된 암호 강도 정책을 적용하지 않습니다. 암호가 구성된 암호 정책에 부합하지 않는 경우에도 Amazon Cognito는 여전히 암호를 수락하여 사용자를 계속 마이그레이션할 수 있습니다. 암호 강도 정책을 적용하고 정책에 부합하지 않는 암호를 거부하려면 코드에서 암호 강도를 검증합니다. 그런 다음 암호가 정책에 부합하지 않는 경우 finalUserStatus를 RESET_REQUIRED로 설정합니다.

messageAction

Amazon Cognito가 일반적으로 새 사용자에게 보내는 시작 메시지 보내기를 거부하려면 이 파라미터를 SUPPRESS로 설정합니다. 함수가 이 파라미터를 반환하지 않으면 Amazon Cognito가 시작 메시지를 보냅니다.

desiredDeliveryMediums

시작 메시지를 이메일로 보내려면 이 파라미터를 EMAIL로 설정하고, 시작 메시지를 SMS로 보내려면 이 파라미터를 SMS로 설정합니다. 함수가 이 파라미터를 반환하지 않으면 Amazon Cognito가 시작 메시지를 SMS로 보냅니다.

forceAliasCreation

이 파라미터가 TRUE로 설정되고 UserAttributes 파라미터의 전화 번호 또는 이메일 주소가 다른 사용자의 별칭으로 이미 존재하는 경우 API 호출이 이전 사용자의 별칭을 새로 생성된 사용자로 마이그레이션합니다. 이전 사용자는 더 이상 해당 별칭을 사용하여 로그인할 수 없습니다.

이 파라미터를 FALSE로 설정하고 별칭이 존재하는 경우 Amazon Cognito가 사용자를 마이그레이션하지 않고 클라이언트 앱에 오류를 반환합니다.

이 파라미터를 반환하지 않는 경우 Amazon Cognito는 해당 값이 'false'라고 가정합니다.

enableSMSMFA

이 파라미터를 true로 설정하는 경우 마이그레이션된 사용자가 로그인하려면 SMS 문자 메시지 다중 인증(MFA)을 완료해야 합니다. 사용자 풀에 MFA가 활성화되어 있어야 합니다. 요청 파라미터의 사용자 속성에 전화 번호가 포함되어야 합니다. 그렇지 않으면 해당 사용자의 마이그레이션이 실패합니다.

예제: 기존 암호가 있는 사용자 마이그레이션

이 Lambda 함수 예는 기존 암호를 가진 사용자를 마이그레이션하고 Amazon Cognito의 환영 인사 메시지를 억제합니다.

Node.js

const validUsers = {
  belladonna: { password: "Test123", emailAddress: "[e-mail]" },
};

// Replace this mock with a call to a real authentication service.
const authenticateUser = (username, password) => {
  if (validUsers[username] && validUsers[username].password === password) {
    return validUsers[username];
  } else {
    return null;
  }
};

const lookupUser = (username) => {
  const user = validUsers[username];

  if (user) {
    return { emailAddress: user.emailAddress };
  } else {
    return null;
  }
};

const handler = async (event) => {
  if (event.triggerSource == "UserMigration_Authentication") {
    // Authenticate the user with your existing user directory service
    const user = authenticateUser(event.userName, event.request.password);
    if (user) {
      event.response.userAttributes = {
        email: user.emailAddress,
        email_verified: "true",
      };
      event.response.finalUserStatus = "CONFIRMED";
      event.response.messageAction = "SUPPRESS";
    }
  } else if (event.triggerSource == "UserMigration_ForgotPassword") {
    // Look up the user in your existing user directory service
    const user = lookupUser(event.userName);
    if (user) {
      event.response.userAttributes = {
        email: user.emailAddress,
        // Required to enable password-reset code to be sent to user
        email_verified: "true",
      };
      event.response.messageAction = "SUPPRESS";
    }
  }

  return event;
};

export { handler };