사전 가입 Lambda 트리거 - Amazon Cognito

사전 가입 Lambda 트리거

사전 가입 Lambda 함수는 Amazon Cognito가 새 사용자를 가입시키기 직전에 시작됩니다. 사용자 지정 확인을 수행하여 가입 프로세스의 일부로 등록 요청을 수락 또는 거부할 수 있습니다.

사전 가입 Lambda 흐름

클라이언트 가입 흐름


                    사전 가입 Lambda 트리거 - 클라이언트 흐름

서버 가입 흐름


                    사전 가입 Lambda 트리거 - 서버 흐름

요청에는 사용자 풀 SignUp 및 AdminCreateUser API 메서드로 전달되는 ValidationData 값에 있는 클라이언트의 확인 데이터가 포함됩니다.

사전 가입 Lambda 트리거 파라미터

이러한 파라미터는 공통 파라미터와 함께 이 Lambda 함수에 필요합니다.

JSON
{ "request": { "userAttributes": { "string": "string", . . . }, "validationData": { "string": "string", . . . }, "clientMetadata": { "string": "string", . . . } }, "response": { "autoConfirmUser": "boolean", "autoVerifyPhone": "boolean", "autoVerifyEmail": "boolean" } }

사전 가입 요청 파라미터

userAttributes

사용자 속성을 나타내는 하나 이상의 이름-값 페어입니다. 속성 이름은 키입니다.

validationData

사용자 등록 요청에 확인 데이터를 포함하는 하나 이상의 이름-값 페어입니다. 사용자 등록 요청에서 확인 데이터가 설정되고 클라이언트로부터 전달됩니다. InitiateAuthAdminInitiateAuth API 작업에서 ClientMetadata 파라미터를 사용하여 이 데이터를 Lambda 함수에 전달할 수 있습니다.

clientMetadata

사전 가입 트리거에 지정하는 Lambda 함수에 사용자 지정 입력으로 제공할 수 있는 하나 이상의 키-값 페어입니다. AdminCreateUser, AdminRespondToAuthChallenge, ForgotPasswordSignUp API 작업에서 ClientMetadata 파라미터를 사용하여 이 데이터를 Lambda 함수에 전달할 수 있습니다.

사전 가입 응답 파라미터

사용자를 자동으로 확인하려면 응답에서 autoConfirmUsertrue로 설정하면 됩니다. autoVerifyEmailtrue로 설정하여 사용자 이메일을 자동으로 확인할 수 있습니다. autoVerifyPhonetrue로 설정하여 사용자 전화 번호를 자동으로 확인할 수 있습니다.

autoConfirmUser

사용자를 자동으로 확인하려면 true로 설정하고 그렇지 않으면 false로 설정합니다.

autoVerifyEmail

가입 중인 사용자의 이메일을 확인한 것으로 설정하려면 true로 설정하고 그렇지 않으면 false로 설정합니다. autoVerifyEmailtrue로 설정되면 email 속성에 null이 아닌 유효한 값이 있어야 합니다. 그렇지 않으면 오류가 발생하고 사용자가 가입을 완료할 수 없습니다.

email 속성이 별칭으로 선택될 경우 autoVerifyEmail이 설정되면 사용자 이메일의 별칭이 생성됩니다. 해당 이메일의 별칭이 이미 있으면 별칭이 새 사용자로 이동하고 이전 사용자의 이메일은 확인되지 않은 것으로 표시됩니다. 자세한 내용은 별칭 개요 단원을 참조하십시오.

autoVerifyPhone

가입 중인 사용자의 전화 번호를 확인한 것으로 설정하려면 true로 설정하고 그렇지 않으면 false로 설정합니다. autoVerifyPhonetrue로 설정되면 phone_number 속성에 null이 아닌 유효한 값이 있어야 합니다. 그렇지 않으면 오류가 발생하고 사용자가 가입을 완료할 수 없습니다.

phone_number 속성이 별칭으로 선택될 경우 autoVerifyPhone이 설정되면 사용자 전화 번호의 별칭이 생성됩니다. 해당 전화 번호의 별칭이 이미 있으면 별칭이 새 사용자로 이동하고 이전 사용자의 전화번호는 확인되지 않은 것으로 표시됩니다. 자세한 내용은 별칭 개요 단원을 참조하십시오.

가입 자습서

사전 가입 Lambda 함수는 사용자 가입 전에 트리거됩니다. JavaScript, Android 및 iOS용 가입 자습서를 참조하십시오.

플랫폼 자습서
JavaScript 자격 증명 SDK JavaScript 사용자 가입
Android 자격 증명 SDK Android 사용자 가입
iOS 자격 증명 SDK iOS 사용자 가입

사전 가입 예제: 등록된 도메인의 사용자 자동 컨펌

사전 가입 Lambda 트리거를 통해 사용자 지정 로직을 추가하여 사용자 풀에 가입 중인 신규 사용자를 확인할 수 있습니다. 이것은 신규 사용자의 가입 방법을 보여주는 JavaScript 프로그램의 예제입니다. 인증 과정에서 사전 가입 Lambda 트리거를 호출합니다.

JavaScript
var attributeList = []; var dataEmail = { Name : 'email', Value : '...' // your email here }; var dataPhoneNumber = { Name : 'phone_number', Value : '...' // your phone number here with +country code and no delimiters in front }; var dataEmailDomain = { Name: "custom:domain", Value: "example.com" } var attributeEmail = new AmazonCognitoIdentity.CognitoUserAttribute(dataEmail); var attributePhoneNumber = new AmazonCognitoIdentity.CognitoUserAttribute(dataPhoneNumber); var attributeEmailDomain = new AmazonCognitoIdentity.CognitoUserAttribute(dataEmailDomain); attributeList.push(attributeEmail); attributeList.push(attributePhoneNumber); attributeList.push(attributeEmailDomain); var cognitoUser; userPool.signUp('username', 'password', attributeList, null, function(err, result){ if (err) { alert(err); return; } cognitoUser = result.user; console.log('user name is ' + cognitoUser.getUsername()); });

이것은 사용자 풀 사전 가입 Lambda 트리거로 가입하기 직전에 호출되는 샘플 Lambda 트리거입니다. 이 트리거는 사용자 지정 속성 custom:domain을 사용하여 특정 이메일 도메인의 신규 사용자를 자동으로 확인할 수 있습니다. 사용자 지정 도메인에 없는 모든 신규 사용자가 사용자 풀에 추가되지만 자동으로 확인되지는 않습니다.

Node.js
exports.handler = (event, context, callback) => { // Set the user pool autoConfirmUser flag after validating the email domain event.response.autoConfirmUser = false; // Split the email address so we can compare domains var address = event.request.userAttributes.email.split("@") // This example uses a custom attribute "custom:domain" if (event.request.userAttributes.hasOwnProperty("custom:domain")) { if ( event.request.userAttributes['custom:domain'] === address[1]) { event.response.autoConfirmUser = true; } } // Return to Amazon Cognito callback(null, event); };
Python
def lambda_handler(event, context): # It sets the user pool autoConfirmUser flag after validating the email domain event['response']['autoConfirmUser'] = False # Split the email address so we can compare domains address = event['request']['userAttributes']['email'].split('@') # This example uses a custom attribute 'custom:domain' if 'custom:domain' in event['request']['userAttributes']: if event['request']['userAttributes']['custom:domain'] == address[1]: event['response']['autoConfirmUser'] = True # Return to Amazon Cognito return event

Amazon Cognito는 이벤트 정보를 Lambda 함수에 전달합니다. 그러면 이 함수에서 응답에 변경 사항을 담아 동일한 이벤트 객체를 Amazon Cognito로 돌려보냅니다. Lambda 콘솔에서 해당 Lambda 트리거와 관련 있는 데이터로 테스트 이벤트를 설정할 수 있습니다. 다음은 이 코드 샘플의 테스트 이벤트입니다.

JSON
{ "request": { "userAttributes": { "email": "testuser@example.com", "custom:domain": "example.com" } }, "response": {} }

사전 가입 예제: 모든 사용자 자동 컨펌 및 자동 확인

이 예에서는 모든 사용자를 자동으로 컨펌하고, 속성이 있는 경우에 확인된 것으로 사용자의 emailphone_number 속성을 설정합니다. 그리고 별칭 기능이 활성화되어 있으면 자동 확인이 설정될 때 phone_numberemail에 대한 별칭이 생성됩니다.

참고

해당 전화 번호의 별칭이 이미 있으면 별칭이 새 사용자로 이동하고 이전 사용자의 phone_number는 확인되지 않은 것으로 표시됩니다. 이메일 주소도 마찬가지입니다. 사용자 풀 ListUsers API를 사용하여 기존 사용자가 신규 사용자의 전화 번호나 이메일 주소를 이미 별칭으로 사용하고 있는지 확인하여 이를 방지할 수 있습니다.

Node.js
exports.handler = (event, context, callback) => { // Confirm the user event.response.autoConfirmUser = true; // Set the email as verified if it is in the request if (event.request.userAttributes.hasOwnProperty("email")) { event.response.autoVerifyEmail = true; } // Set the phone number as verified if it is in the request if (event.request.userAttributes.hasOwnProperty("phone_number")) { event.response.autoVerifyPhone = true; } // Return to Amazon Cognito callback(null, event); };
Python
def lambda_handler(event, context): # Confirm the user event['response']['autoConfirmUser'] = True # Set the email as verified if it is in the request if 'email' in event['request']['userAttributes']: event['response']['autoVerifyEmail'] = True # Set the phone number as verified if it is in the request if 'phone_number' in event['request']['userAttributes']: event['response']['autoVerifyPhone'] = True # Return to Amazon Cognito return event

Amazon Cognito는 이벤트 정보를 Lambda 함수에 전달합니다. 그러면 이 함수에서 응답에 변경 사항을 담아 동일한 이벤트 객체를 Amazon Cognito로 돌려보냅니다. Lambda 콘솔에서 해당 Lambda 트리거와 관련 있는 데이터로 테스트 이벤트를 설정할 수 있습니다. 다음은 이 코드 샘플의 테스트 이벤트입니다.

JSON
{ "request": { "userAttributes": { "email": "user@example.com", "phone_number": "+12065550100" } }, "response": {} }