Method: accounts.mfaEnrollment.finalize

ユーザーの第 2 要素の登録が完了します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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.
}
フィールド
idToken

string

必須。ID トークン。

displayName

string

同じタイプまたは異なるタイプの異なる 2 段階認証プロセスを区別するためにユーザーが入力する表示名。

tenantId

string

MFA を登録するユーザーが属する Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトに属します。

共用体フィールド verification_info。確認が必要な MFA 登録情報。verification_info は次のいずれかになります。
phoneVerificationInfo

object (FinalizeMfaPhoneRequestInfo)

電話確認用の SMS の送信を承認するための確認情報。

totpVerificationInfo

object (FinalizeMfaTotpEnrollmentRequestInfo)

TOTP の確認情報。

レスポンスの本文

mfaEnrollment.finalize レスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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.
}
フィールド
idToken

string

ID トークンが更新され、MFA の登録が反映されました。

refreshToken

string

更新トークンを更新して、MFA の登録を反映しました。

共用体フィールド auxiliary_auth_info。MFA で確認された登録情報。auxiliary_auth_info は次のいずれかになります。
phoneAuthInfo

object (FinalizeMfaPhoneResponseInfo)

電話認証に固有の補助認証情報。

totpAuthInfo

object (FinalizeMfaTotpEnrollmentResponseInfo)

TOTP 認証に固有の補助認証情報。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

詳細については、Authentication Overview をご覧ください。

FinalizeMfaTotpEnrollmentRequestInfo

FinalizeMfa の TOTP 認証に固有の Mfa リクエスト情報。

JSON 表現
{
  "sessionInfo": string,
  "verificationCode": string
}
フィールド
sessionInfo

string

登録セッションを表す不透明な文字列。

verificationCode

string

ユーザーが入力した確認コード。

FinalizeMfaTotpEnrollmentResponseInfo

この型にはフィールドがありません。

FinalizeMfa の TOTP 認証に固有の Mfa レスポンス情報。