Method: accounts.mfaEnrollment.finalize

Die Registrierung eines zweiten Faktors für den Nutzer wird abgeschlossen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Pflichtangabe. ID-Token

displayName

string

Anzeigename, der von Nutzern eingegeben wird, um zwischen verschiedenen zweiten Faktoren mit demselben oder einem anderen Typ zu unterscheiden.

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 verification_info. Informationen zur MFA-Registrierung müssen bestätigt werden. Für verification_info ist nur einer der folgenden Werte zulässig:
phoneVerificationInfo

object (FinalizeMfaPhoneRequestInfo)

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

totpVerificationInfo

object (FinalizeMfaTotpEnrollmentRequestInfo)

Bestätigungsinformationen für TOTP

Antworttext

mfaEnrollment.finalize-Antwort

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

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

string

ID-Token wurde aktualisiert, um die MFA-Registrierung widerzuspiegeln.

refreshToken

string

Aktualisierungstoken wurde entsprechend der MFA-Registrierung aktualisiert.

Union-Feld auxiliary_auth_info. Informationen zur Anmeldung, die mit der Multi-Faktor-Authentifizierung bestätigt wurden. Für auxiliary_auth_info ist nur einer der folgenden Werte zulässig:
phoneAuthInfo

object (FinalizeMfaPhoneResponseInfo)

Zusätzliche Authentifizierungsinformationen, die für die Telefonauthentifizierung spezifisch sind.

totpAuthInfo

object (FinalizeMfaTotpEnrollmentResponseInfo)

Informationen zur sekundären Authentifizierung, die für die TOTP-Authentifizierung spezifisch sind.

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.

FinalizeMfaTotpEnrollmentRequestInfo

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

JSON-Darstellung
{
  "sessionInfo": string,
  "verificationCode": string
}
Felder
sessionInfo

string

Ein nicht transparenter String, der die Registrierungssitzung darstellt.

verificationCode

string

Vom Nutzer eingegebener Bestätigungscode.

FinalizeMfaTotpEnrollmentResponseInfo

Dieser Typ hat keine Felder.

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