Method: accounts.mfaEnrollment.start

Schritt 1 der MFA-Registrierung Im Fall einer SMS wird ein SMS-Bestätigungscode an den Nutzer gesendet.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
idToken

string

Pflichtangabe. ID-Token des Nutzers.
tenantId

string

Die ID des Identity Platform-Mandanten, zu dem der Nutzer gehört, der die Bestätigung in zwei Schritten registriert. Wenn nicht festgelegt, gehört der Nutzer zum Standard-Identity Platform-Projekt.
Union-Feld enrollment_info. Informationen zur MFA nach Art des zweiten Faktors. Für enrollment_info ist nur einer der folgenden Werte zulässig:
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

Anmeldedaten für die TOTP-Authentifizierung

Antworttext

mfaEnrollment.start-Antwort.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld enrollment_response. MFA-Registrierungsantwort nach dem Typ des zweiten Faktors Für enrollment_response ist nur einer der folgenden Werte zulässig:
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

Bestätigungsinformationen, um das Senden einer SMS zur Bestätigung des Smartphones zu autorisieren.
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

Informationen zur Registrierungsantwort, die speziell für die TOTP-Authentifizierung gelten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

StartMfaTotpEnrollmentRequestInfo

Dieser Typ hat keine Felder.

Informationen zur MFA-Anfrage, die speziell für die TOTP-Authentifizierung für StartMfa gelten.

StartMfaTotpEnrollmentResponseInfo

Informationen zur MFA-Antwort, die speziell für die TOTP-Authentifizierung für StartMfa gelten.

JSON-Darstellung 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Felder
sharedSecretKey

string

Ein Base32-codierter String, der das gemeinsame TOTP-Secret darstellt.

Die Base32-Codierung ist die in RFC4648#section-6 angegebene Codierung. Das entspricht der Base32-Codierung aus RFC3548#section-5.
verificationCodeLength

integer

Die Länge des zu generierenden Bestätigungscodes.
hashingAlgorithm

string

Der Hash-Algorithmus, der zum Generieren des Bestätigungscodes verwendet wird.
periodSec

integer

Dauer in Sekunden, nach der sich der Bestätigungscode ändert.
sessionInfo

string

Ein codierter String, der die Registrierungssitzung darstellt.
finalizeEnrollmentTime

string (Timestamp format)

Der Zeitpunkt, bis zu dem die Registrierung abgeschlossen sein muss.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".