Method: accounts.mfaEnrollment.start

MFA 登録プロセスのステップ 1。SMS の場合、SMS 確認コードがユーザーに送信されます。

HTTP リクエスト

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

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

リクエストの本文

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

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

string

必須。ユーザーの ID トークン。
tenantId

string

MFA を登録するユーザーが属する Identity Platform テナントの ID。設定されていない場合、ユーザーはデフォルトの Identity Platform プロジェクトに属します。
共用体フィールド enrollment_info。第 2 要素の種類別の MFA 情報。enrollment_info は次のいずれかになります。
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

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

object (StartMfaTotpEnrollmentRequestInfo)

TOTP 認証に固有のログイン情報。

レスポンスの本文

mfaEnrollment.start レスポンス。

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

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.
}
フィールド
共用体フィールド enrollment_response。第 2 要素の種類別の MFA 開始登録レスポンス。enrollment_response は次のいずれかになります。
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

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

object (StartMfaTotpEnrollmentResponseInfo)

TOTP 認証に固有の登録レスポンス情報。

認可スコープ

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

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

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

StartMfaTotpEnrollmentRequestInfo

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

StartMfa の TOTP 認証に固有の MFA リクエスト情報。

StartMfaTotpEnrollmentResponseInfo

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

JSON 表現 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
フィールド
sharedSecretKey

string

共有 TOTP シークレットを表す base 32 でエンコードされた文字列。

ベース 32 エンコードは、RFC4648#section-6 で指定されています。（これは RFC3548#section-5 の base32 エンコードと同じです）。
verificationCodeLength

integer

生成する必要がある確認コードの長さ。
hashingAlgorithm

string

確認コードの生成に使用されるハッシュ アルゴリズム。
periodSec

integer

確認コードが変更されるまでの時間（秒単位）。
sessionInfo

string

登録セッションを表すエンコードされた文字列。
finalizeEnrollmentTime

string (Timestamp format)

登録を完了する必要がある時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。