Method: accounts.mfaEnrollment.start

Etapa 1 do processo de registro do MFA. No caso do SMS, um código de verificação é enviado ao usuário.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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

Obrigatório. Token de ID do usuário.
tenantId

string

O ID do locatário do Identity Platform ao qual o usuário que está registrando a MFA pertence. Se não for definido, o usuário pertence ao projeto padrão do Identity Platform.
Campo de união enrollment_info. Informações de MFA por tipo de segundo fator. enrollment_info pode ser apenas de um dos tipos a seguir:
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

Informações de login específicas para a autenticação TOTP.

Corpo da resposta

Resposta mfaEnrollment.start.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação 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ão enrollment_response. Resposta de início da inscrição da MFA por tipo de segundo fator. enrollment_response pode ser apenas de um dos tipos a seguir:
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

Informações de resposta de registro específicas para a autenticação TOTP.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

StartMfaTotpEnrollmentRequestInfo

Esse tipo não tem campos.

Informações da solicitação de MFA específicas para a autenticação TOTP para StartMfa.

StartMfaTotpEnrollmentResponseInfo

Informações de resposta da MFA específicas para a autenticação TOTP para StartMfa.

Representação JSON 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Campos
sharedSecretKey

string

Uma string codificada em base 32 que representa o segredo TOTP compartilhado.

A codificação de base 32 é a especificada pela RFC4648#section-6. Ela é igual à codificação Base32 da RFC3548#section-5.
verificationCodeLength

integer

A extensão do código de verificação que precisa ser gerado.
hashingAlgorithm

string

O algoritmo de hash usado para gerar o código de verificação.
periodSec

integer

Duração em segundos em que o código de verificação vai mudar.
sessionInfo

string

Uma string codificada que representa a sessão de inscrição.
finalizeEnrollmentTime

string (Timestamp format)

O horário em que a inscrição precisa ser concluída.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".