注册前 Lambda 触发器

在 Amazon Cognito 注册新用户之前不久，它会激活预注册 AWS Lambda 函数。在注册过程中，您可以使用此函数执行自定义验证，并根据验证结果接受或拒绝注册请求。

注册前 Lambda 流程

客户端注册流程

服务器注册流程

请求包括来自客户端的验证数据。这些数据来自传递给用户池 SignUp 和 AdminCreateUser API 方法的ValidationData值。

注册前 Lambda 触发器参数

Amazon Cognito 传递给此 Lambda 函数的请求是以下参数和 Amazon Cognito 添加到所有请求中的常用参数的组合。

JSON

{
    "request": {
        "userAttributes": {
            "string": "string",
            . . .
        },
        "validationData": {
            "string": "string",
            . . .
         },
        "clientMetadata": {
            "string": "string",
            . . .
         }
    },

    "response": {
        "autoConfirmUser": "boolean",
        "autoVerifyPhone": "boolean",
        "autoVerifyEmail": "boolean"
    }
}

注册前请求参数

userAttributes

表示用户属性的一个或多个名称/值对。属性名称是键。

validationData

一个或多个包含用户属性数据的键值对，您的应用程序在创建新用户的请求中将这些数据传递给 Amazon Cognito。在您AdminCreateUser或 SignUpAPI 请求的 ValidationData 参数中将此信息发送到您的 Lambda 函数。

Amazon Cognito 不会将你的 ValidationData 数据设置为你创建的用户的属性。 ValidationData 是您为注册前 Lambda 触发器而提供的临时用户信息。

clientMetadata

一个或多个键值对，您可以将其作为自定义输入内容提供给为注册前触发器指定的 Lambda 函数。您可以使用以下 API 操作中的 ClientMetadata参数将此数据传递给您的 Lambda 函数：AdminCreateUser、AdminRespondToAuthChallengeForgotPassword、和。SignUp

注册前响应参数

在响应中，如果您想要自动确认用户，则您可以将 autoConfirmUser 设置为 true。您可以将 autoVerifyEmail 设置为 true，以自动验证用户的电子邮件。您可以将 autoVerifyPhone 设置为 true，以自动验证用户的电话号码。

注意

AdminCreateUser API 触发注册前 Lambda 函数时，Amazon Cognito 会忽略响应参数 autoVerifyPhone、autoVerifyEmail 和 autoConfirmUser。

autoConfirmUser

设置为 true 以自动确认用户，否则设置为 false。

autoVerifyEmail

设置为 true 可以设置为所注册用户已通过验证的电子邮件地址，否则为 false。如果 autoVerifyEmail 设置为 true，则 email 属性必须具有有效的非空值。否则将出现错误，用户将无法完成注册。

如果选择 email 属性作为别名，则在设置了 autoVerifyEmail 时将为用户的电子邮件地址创建别名。如果已存在具有该电子邮件地址的别名，则别名将移动到新用户，以前用户的电子邮件地址将标记为未验证。有关更多信息，请参阅自定义登录属性。

autoVerifyPhone

设置为 true 可以设置为所注册用户已通过验证的电话号码，否则为 false。如果 autoVerifyPhone 设置为 true，则 phone_number 属性必须具有有效的非空值。否则将出现错误，用户将无法完成注册。

如果选择 phone_number 属性作为别名，则在设置了 autoVerifyPhone 时将为用户的电话号码创建别名。如果已存在具有该电话号码的别名，则别名将移动到新用户，以前用户的电话号码将标记为未验证。有关更多信息，请参阅自定义登录属性。

注册教程

注册前 Lambda 函数在用户注册前触发。请参阅这些适用于 JavaScript安卓和 iOS 的 Amazon Cognito 注册教程。

平台	教程
JavaScript 身份软件开发工具包	使用注册用户 JavaScript
Android 身份开发工具包	通过 Android 注册用户
iOS 身份开发工具包	通过 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": "[e-mail]",
            "custom:domain": "example.com"
        }
    },
    "response": {}
}

注册前示例：自动确认和自动验证所有用户

此示例确认所有用户并将用户的 email 和 phone_number 属性设置为“已验证”（如果该属性存在）。此外，如果启用了别名，当设置了自动验证时，将为 phone_number 和 email 创建别名。

注意

如果已存在具有相同电话号码的别名，则别名将移动到新用户，以前用户的 phone_number 将标记为未验证。电子邮件地址也是如此。为了防止这种情况发生，您可以使用用户池 ListUsers API 来查看是否有现有用户已在使用新用户的电话号码或电子邮件地址作为别名。

Node.js

const handler = async (event) => {
  // 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 event;
};

export { handler };

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": "[e-mail]",
      "phone_number": "[phone]"
    }
  },
  "response": {}
}

注册前示例：如果用户名少于五个字符，则拒绝注册

此示例检查注册请求中用户名的长度。如果用户输入的名称长度少于五个字符，则该示例将返回错误。

Node.js

exports.handler = (event, context, callback) => {
    // Impose a condition that the minimum length of the username is 5 is imposed on all user pools.
    if (event.userName.length < 5) {
        var error = new Error("Cannot register users with username less than the minimum length of 5");
        // Return error to Amazon Cognito
        callback(error, event);
    }
    // Return to Amazon Cognito
    callback(null, event);
};

Python

def lambda_handler(event, context):
    if len(event['userName']) < 5:
        raise Exception("Cannot register users with username less than the minimum length of 5")
    # Return to Amazon Cognito
    return event

Amazon Cognito 将事件信息传递给 Lambda 函数。随后，该函数将相同事件对象随同响应中的任何更改返回给 Amazon Cognito。在 Lambda 控制台中，您可以设置一个测试事件，该事件包含与您的 Lambda 触发器相关的数据。以下是此代码示例的一个测试事件：

JSON

{
  "userName": "rroe",
  "response": {}
}