Method: accounts.mfaEnrollment.finalize

Conclui o registro de um segundo fator para o usuário.

Solicitação HTTP

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

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,
  "displayName": string,
  "tenantId": string,

  // Union field verification_info can be only one of the following:
  "phoneVerificationInfo": {
    object (FinalizeMfaPhoneRequestInfo)
  },
  "totpVerificationInfo": {
    object (FinalizeMfaTotpEnrollmentRequestInfo)
  }
  // End of list of possible types for union field verification_info.
}
Campos
idToken

string

Obrigatório. Token de ID.

displayName

string

Nome de exibição inserido pelos usuários para distinguir entre diferentes segundos fatores com o mesmo tipo ou diferentes tipos.

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 verification_info. Informações de registro de MFA para verificação. verification_info pode ser apenas de um dos tipos a seguir:
phoneVerificationInfo

object (FinalizeMfaPhoneRequestInfo)

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

totpVerificationInfo

object (FinalizeMfaTotpEnrollmentRequestInfo)

Informações de verificação para TOTP.

Corpo da resposta

mfaEnrollment.finalize response.

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

Representação JSON
{
  "idToken": string,
  "refreshToken": string,

  // Union field auxiliary_auth_info can be only one of the following:
  "phoneAuthInfo": {
    object (FinalizeMfaPhoneResponseInfo)
  },
  "totpAuthInfo": {
    object (FinalizeMfaTotpEnrollmentResponseInfo)
  }
  // End of list of possible types for union field auxiliary_auth_info.
}
Campos
idToken

string

O token de identificação foi atualizado para refletir a inscrição no MFA.

refreshToken

string

O token de atualização foi atualizado para refletir a inscrição no MFA.

Campo de união auxiliary_auth_info. Informações de registro verificadas pela autenticação multifator. auxiliary_auth_info pode ser apenas de um dos tipos a seguir:
phoneAuthInfo

object (FinalizeMfaPhoneResponseInfo)

Informações de autenticação auxiliares específicas para a autenticação por telefone.

totpAuthInfo

object (FinalizeMfaTotpEnrollmentResponseInfo)

Informações de autenticação auxiliares 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.

FinalizeMfaTotpEnrollmentRequestInfo

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

Representação JSON
{
  "sessionInfo": string,
  "verificationCode": string
}
Campos
sessionInfo

string

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

verificationCode

string

Código de verificação inserido pelo usuário.

FinalizeMfaTotpEnrollmentResponseInfo

Esse tipo não tem campos.

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