Method: accounts.mfaEnrollment.finalize

Termine l'inscription d'un deuxième facteur pour l'utilisateur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
idToken

string

Obligatoire. Jeton d'ID
displayName

string

Nom à afficher saisi par les utilisateurs pour distinguer les différents facteurs d'authentification à deux facteurs du même type ou de types différents.
tenantId

string

ID du locataire Identity Platform auquel appartient l'utilisateur qui active l'authentification multifacteur. Si ce paramètre n'est pas défini, l'utilisateur appartient au projet Identity Platform par défaut.
Champ d'union verification_info. Informations d'enregistrement de l'authentification multifacteur à valider verification_info ne peut être qu'un des éléments suivants :
phoneVerificationInfo

object (FinalizeMfaPhoneRequestInfo)

Informations de validation pour autoriser l'envoi d'un SMS de validation du numéro de téléphone.
totpVerificationInfo

object (FinalizeMfaTotpEnrollmentRequestInfo)

Informations de validation pour TOTP.

Corps de la réponse

Réponse mfaEnrollment.finalize.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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.
}
Champs
idToken

string

Le jeton d'ID a été mis à jour pour refléter l'inscription au MFA.
refreshToken

string

Le jeton d'actualisation a été mis à jour pour refléter l'inscription à l'authentification multifacteur.
Champ d'union auxiliary_auth_info. Informations d'enregistrement validées par l'authentification multifacteur. auxiliary_auth_info ne peut être qu'un des éléments suivants :
phoneAuthInfo

object (FinalizeMfaPhoneResponseInfo)

Informations d'authentification auxiliaires spécifiques à l'authentification par téléphone.
totpAuthInfo

object (FinalizeMfaTotpEnrollmentResponseInfo)

Informations d'authentification auxiliaires spécifiques à l'authentification TOTP.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.

FinalizeMfaTotpEnrollmentRequestInfo

Informations sur la requête d'authentification multifacteur spécifiques à l'authentification TOTP pour FinalizeMfa.

Représentation JSON 
{
  "sessionInfo": string,
  "verificationCode": string
}
Champs
sessionInfo

string

Chaîne opaque représentant la session d'enregistrement.
verificationCode

string

Code de validation saisi par l'utilisateur.

FinalizeMfaTotpEnrollmentResponseInfo

Ce type ne comporte aucun champ.

Informations de réponse de l'authentification multifacteur spécifiques à l'authentification TOTP pour FinalizeMfa.