Method: accounts.mfaEnrollment.start

Première étape du processus d'inscription au MFA. Dans le cas d'un SMS, un code de validation est envoyé à l'utilisateur.

Requête HTTP

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

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,
  "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.
}
Champs
idToken

string

Obligatoire. Jeton d'ID de l'utilisateur.
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 enrollment_info. Informations sur l'authentification multifacteur par type de deuxième facteur. enrollment_info ne peut être qu'un des éléments suivants :
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

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

object (StartMfaTotpEnrollmentRequestInfo)

Informations de connexion spécifiques à l'authentification TOTP.

Corps de la réponse

Réponse mfaEnrollment.start.

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

Représentation 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.
}
Champs
Champ d'union enrollment_response. Réponse de début d'inscription à l'authentification multifacteur par type de deuxième facteur. enrollment_response ne peut être qu'un des éléments suivants :
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

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

object (StartMfaTotpEnrollmentResponseInfo)

Informations de réponse d'enregistrement 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.

StartMfaTotpEnrollmentRequestInfo

Ce type ne comporte aucun champ.

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

StartMfaTotpEnrollmentResponseInfo

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

Représentation JSON 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Champs
sharedSecretKey

string

Chaîne encodée en base 32 représentant la clé secrète TOTP partagée.

L'encodage base 32 est celui spécifié dans la section 6 de la norme RFC 4648. Il s'agit de la même chose que l'encodage en base 32 de la RFC 3548, section 5.
verificationCodeLength

integer

Longueur du code de validation à générer.
hashingAlgorithm

string

Algorithme de hachage utilisé pour générer le code de validation.
periodSec

integer

Durée en secondes pendant laquelle le code de validation change.
sessionInfo

string

Chaîne encodée représentant la session d'enregistrement.
finalizeEnrollmentTime

string (Timestamp format)

Heure à laquelle l'inscription doit se terminer.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".