Method: accounts.mfaEnrollment.start

多重身份验证 (MFA) 注册流程的第一步。对于短信验证，系统会向用户发送短信验证码。

HTTP 请求

POST https://identitytoolkit.googleapis.com/v2/accounts/mfaEnrollment:start

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "idToken": string,
  "tenantId": string,

  // Union field enrollment_info can be only one of the following:
  "phoneEnrollmentInfo": {
    object (StartMfaPhoneRequestInfo)
  },
  "totpEnrollmentInfo": {
    object (StartMfaTotpEnrollmentRequestInfo)
  }
  // End of list of possible types for union field enrollment_info.
}
字段
idToken

string

必需。用户的 ID 令牌。
tenantId

string

注册多重身份验证的用户所属的 Identity Platform 租户的 ID。如果未设置，则用户属于默认的 Identity Platform 项目。
联合字段 enrollment_info。按第二重身份验证类型显示的 MFA 信息。enrollment_info 只能是下列其中一项：
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

用于授权发送短信以进行电话验证的验证信息。
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

特定于 TOTP 身份验证的登录信息。

响应正文

mfaEnrollment.start 响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{

  // Union field enrollment_response can be only one of the following:
  "phoneSessionInfo": {
    object (StartMfaPhoneResponseInfo)
  },
  "totpSessionInfo": {
    object (StartMfaTotpEnrollmentResponseInfo)
  }
  // End of list of possible types for union field enrollment_response.
}
字段
联合字段 enrollment_response。按第二重身份验证类型显示的多重身份验证开始注册响应。enrollment_response 只能是下列其中一项：
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

用于授权发送短信以进行电话验证的验证信息。
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

特定于 TOTP 身份验证的注册响应信息。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅 Authentication Overview。

StartMfaTotpEnrollmentRequestInfo

此类型没有字段。

特定于 StartMfa 的 TOTP 身份验证的 Mfa 请求信息。

StartMfaTotpEnrollmentResponseInfo

特定于 StartMfa 的 TOTP 身份验证的 Mfa 响应信息。

JSON 表示法 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
字段
sharedSecretKey

string

一个以 base 32 编码的字符串，表示共享的 TOTP 密钥。

采用的是 RFC4648#section-6 中指定的基于 32 的编码。（这与 RFC3548#section-5 中的 base 32 编码相同）。
verificationCodeLength

integer

需要生成的验证码的长度。
hashingAlgorithm

string

用于生成验证码的哈希算法。
periodSec

integer

验证码更改的持续时间（以秒为单位）。
sessionInfo

string

表示注册会话的编码字符串。
finalizeEnrollmentTime

string (Timestamp format)

注册必须完成的时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。