Method: accounts.mfaEnrollment.start

Primer paso del proceso de inscripción de la AUA. En el caso de los SMS, se envía un código de verificación por SMS al usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
idToken

string

Obligatorio. Token de ID del usuario
tenantId

string

El ID del grupo de usuarios de Identity Platform al que pertenece el usuario que inscribe la MFA. Si no se establece, el usuario pertenece al proyecto predeterminado de Identity Platform.
Campo de unión enrollment_info. Información de la MFA por tipo de segundo factor enrollment_info puede ser solo uno de los siguientes:
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

Información de verificación para autorizar el envío de un SMS de verificación telefónica
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

Información de acceso específica de la autenticación de TOTP

Cuerpo de la respuesta

mfaEnrollment.start response.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación 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.
}
Campos
Campo de unión enrollment_response. Respuesta de la inscripción de inicio de la MFA por tipo de segundo factor enrollment_response puede ser solo uno de los siguientes:
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

Información de verificación para autorizar el envío de un SMS de verificación telefónica
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

Información de la respuesta de inscripción específica de la autenticación TOTP.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

StartMfaTotpEnrollmentRequestInfo

Este tipo no tiene campos.

Información de la solicitud de MFA específica para la autenticación de TOTP para StartMfa.

StartMfaTotpEnrollmentResponseInfo

Información de respuesta de MFA específica para la autenticación de TOTP para StartMfa.

Representación JSON 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Campos
sharedSecretKey

string

Es una cadena codificada en base 32 que representa el secreto compartido de TOTP.

La codificación base 32 es la que se especifica en RFC4648#section-6. (Esto es lo mismo que la codificación en base 32 de RFC3548#section-5).
verificationCodeLength

integer

Es la longitud del código de verificación que se debe generar.
hashingAlgorithm

string

Es el algoritmo de hash que se usa para generar el código de verificación.
periodSec

integer

Es la duración en segundos en la que cambiará el código de verificación.
sessionInfo

string

Es una cadena codificada que representa la sesión de inscripción.
finalizeEnrollmentTime

string (Timestamp format)

La hora a la que debe finalizar la inscripción

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".