电子邮件/密码身份验证

新用户帐户状态

用户账户可以处于两种状态之一：待处理和已确认。

启动确认进程后，Atlas App Services 将创建一个用户账户并将状态设置为 Pending Confirmation。在这种状态下，用户无法登录。由于该电子邮件地址现已与用户帐户关联，因此无法重新注册同一电子邮箱。

如果账户处于待处理状态，则用户必须在登录前确认其账户。用户确认其账户时，Atlas App Services 会将状态设置为 Confirmed（已确认），用户可以登录。

如果自动确认用户，则创建账户时状态设置为 Confirmed，用户注册后可立即登录。

可以在用户界面中或通过 App Services API 查看待处理的用户帐户列表：

发送确认电子邮件

使用此确认方法，用户必须在注册后回复电子邮件。该电子邮件包含指向确认 URL 的链接。用户必须在 30 分钟内访问此链接，以确认他们控制了该电子邮件地址。

配置以下设置，以便 App Services 自动发送确认电子邮件：

• Email Confirmation URL：每封确认电子邮件中包含的 URL 的基础。App Services 会向此 URL 附加一个唯一的 token 和 tokenId。它们将用作查询参数，以便为每个确认创建唯一链接。要确认用户，请首先从该用户的唯一 URL 中提取这些查询参数。然后，将 token 和 tokenId 传递给客户端 SDK 的 confirmUser 函数。

  移动应用程序可以直接在应用程序中处理电子邮件确认。 为此，请配置 深层链接 在 Android 或 通用链接 中 在iOS中。

• Email Confirmation Subject：App Services 发送的电子邮件的主题行。此值为可选项，如果省略，App Services 会改用默认主题行。自定义电子邮件确认主题最多可包含 256 个字符。

运行确认函数

您可以在新用户注册时 Run a Confirmation Function（运行确认函数）。App Services 会将确认令牌、令牌 ID 和用户的电子邮件传递给您创建的函数。然后您的函数将执行确认用户所需的逻辑，并返回以下结果对象之一，下文将予以详细说明：

• { status: 'success' }

• { status: 'fail' }

• { status: 'pending' }

通过使用函数，您可以定义自定义逻辑来确认用户。例如，您的函数可能：

• 从特定域发送自定义确认电子邮件。使用外部服务通过特定模板发送这些内容。

• 从 MongoDB Atlas 的集合或外部 REST 服务中读取用户权限。

• 通过电子邮件以外的服务（例如短信）发送确认消息。

该自定义确认函数签名有一个参数。它是包含用户数据和确认令牌的对象。这些字段是：

自定义用户确认函数会返回一个带有状态字段的对象。下表描述了此字段的潜在值：

用户确认函数的示例如下：

1. 检查提供的电子邮件是否有效。

2. 确认给定的电子邮件地址可以访问特定服务。

3. 向用户发送短信。

4. 如果消息发送成功，则通知 Atlas App Services 创建一个处于“待处理”状态的新帐户。

exports = ({ token, tokenId, username }) => {
   // Validate the username
   const isValidEmail = myCustomValidatorService.validate(username);
   // Check if the user has access to this service
   const isPrivileged =
      myCustomAuthorizationService.hasAccess(username)
   // Send a message to the user so that they can confirm themselves
   const msgSendSuccessful = isValidEmail && isPrivileged
      && mySmsService.send(username, token, tokenId)
   if ( msgSendSuccessful ) {
      return { status: 'pending' };
   } else {
      return { status: 'fail' };
   }
}

除非自定义函数自动确认用户，否则您必须提供一种方法让用户在函数触发后完成确认过程。完成其他确认步骤后，调用 SDK 的“确认用户”方法，从而在 Atlas App Services 上完成用户账户创建。

自动确认用户

您可以将提供商配置为 Automatically Confirm Users。选中后，App Services 将在注册后立即确认新的电子邮件/密码用户。

发送密码重置电子邮件

您可以配置该提供商以便Send a Password Reset Email.。当用户请求重置密码时，App Services 会将密码重置 URL 发送到用户的电子邮件地址。该用户必须在 30 分钟内访问此 URL。

配置密码重置电子邮件时，您可以配置以下设置：

• Password Reset URL：这是每封密码重置电子邮件中包含的 URL 的基础。App Services 会向此 URL 附加一个唯一的 token 和 tokenId。这些查询参数用于为每次密码重置创建唯一的链接。要重置用户的密码，请从用户的唯一 URL 中提取这些查询参数。将 token 和 tokenId 传递给 Client SDK 的 resetPassword 函数。

• Reset Password Email Subject：App Services 发送的电子邮件的主题行。此值是可选的：如果省略，App Services 会改用默认主题行。自定义密码重置主题最多可包含 256 个字符。

移动应用程序可以直接在应用中处理密码重置。在 Android 中配置深度链接或在 iOS 中配置通用链接。

运行密码重置功能

您可以将提供商配置为 Run a Password Reset Function。您可以为 App Services 定义一个函数，当您在 SDK 中 callResetPasswordFunction() 时，该函数运行。App Services 将用户的电子邮件、所需的新密码、确认令牌和令牌 ID 传递给您创建的函数。然后，在重置密码之前，该函数执行确认用户身份所需的逻辑。

App Services 可以立即重置用户的密码。或者您可以要求客户端应用程序的其他确认。

App Services 函数必须返回一个包含 status 键的对象。键映射到具有以下值之一的字符串，下面将详细说明这些值：

• { status: 'success' }

• { status: 'fail' }

• { status: 'pending' }

您可以使用自定义密码重置函数来定义自己的密码重置流程：

• 使用外部服务，通过特定模板从特定域发送自定义密码重置电子邮件。

• 与 MongoDB Atlas 集合交互以实施密码重置“冷却期”。这可以防止在特定时间范围内对单个帐户进行过多的密码重置尝试。

• 通过电子邮件以外的服务发送自定义密码重置消息。

自定义密码重置函数签名是可变的：它可接受任意数量的参数。第一个始终是包含用户数据和确认令牌的对象。以下所有参数均为自定义参数。它们作为参数集合传递到客户端 SDK。例如，客户端 SDK 调用：

callResetPasswordFunction("myUsername", "newPassword", ["Security Question Answer 1", "Security Question Answer 2", "securityCode:0510"])

成为密码重置函数的自定义签名：

resetFunc({username, password, token, tokenId, currentPasswordValid}, securityAnswer1, securityAnswer2, securitySMSCode)

在自定义密码重置函数中，必须将对象作为第一个参数传递。下表描述了在此对象中找到的字段：

自定义密码重置函数必须返回包含 status 字段的对象。这个 status 字段的值可以是：

自定义密码重置函数可能包括与这个示例类似的元素：

exports = ({ token, tokenId, username, password, currentPasswordValid }) => {
   // check if the username corresponds to a real user
   const isUser = myCustomValidator.validate(username);
   // check if the user is attempting to reset their password to their current password
   if (currentPasswordValid) {
     myCustomNotifier.sendMessage(username, "Cannot reset password to current password.");
     return { status: 'fail' };
   }
   // check if the user has requested a password reset too often recently
   const isNotCoolingDown = myCustomCooldownService.canReset(username, 'myCustomService')
   // send a message to the user in some way so that the user can confirm themselves
   const msgSendSuccessful = isUser && isNotCoolingDown && myCustomMsgr.send(username, token, tokenId)
   if ( msgSendSuccessful ) {
      return { status: 'pending' };
   } else {
      return { status: 'fail' };
   }
}