Package google.cloud.identitytoolkit.v2alpha1

インデックス

AccountManagementService

Identity Toolkit のアカウント管理

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

ユーザーの MFA 要素として電話番号の登録が完了します。

認可スコープ

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

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

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

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

ユーザーの MFA 登録確認 SMS を送信します。

認可スコープ

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

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

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

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

ユーザーの 1 つの MFA を取り消す

認可スコープ

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

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

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

AuthenticationV2Alpha1Service

Identity Toolkit の認証

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

MultiFactorAuth チャレンジを検証し、MultiFactorAuth ログインを実行します。
StartMfaSignIn

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

MultiFactorAuth チャレンジを送信します。

AutoRetrievalInfo

SMS を自動取得するために必要な情報。

フィールド
app_signature_hash

string

Google Play 開発者サービスの SMS Retriever API 用の Android アプリの署名ハッシュ。

FinalizeMfaEnrollmentRequest

ユーザーの MFA 要素として電話番号の登録が完了します。

フィールド
id_token

string

必須。認証済みユーザーを示す Firebase の第 1 要素 ID トークン。
mfa_provider

MfaProvider

必須。2 つ目の要素の種類。
display_name

string

同じタイプまたは異なるタイプの異なる多要素認証を区別するためにユーザーが入力する表示名。
共用体フィールド verification_info。必須。確認が必要な多要素認証の登録情報。verification_info は次のいずれかになります。
phone_verification_info

FinalizeMfaPhoneRequestInfo

スマートフォン認証に固有の確認情報。

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment レスポンス。

フィールド
id_token

string

MFA ユーザーの Firebase ID トークン。
refresh_token

string

MFA ユーザーの更新トークン。MFA ID トークンを取得します。
共用体フィールド auxiliary_auth_info。MultiFactor で確認された登録情報。auxiliary_auth_info は次のいずれかになります。
phone_auth_info

FinalizeMfaPhoneResponseInfo

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

FinalizeMfaPhoneRequestInfo

スマートフォン認証に固有の Mfa リクエスト情報。

フィールド
session_info

string

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

string

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

string

Android のみ。GmsCore による「即時」の電話番号確認に使用されます。
phone_number

string

Android の確認証明書を提示する場合は必須です。

FinalizeMfaPhoneResponseInfo

電話認証に固有の mfa レスポンス情報。

フィールド
android_verification_proof

string

Android のみ。Android デバイスに関連付けられた有効なコードの長期的な代替手段。
android_verification_proof_expire_time

Timestamp

Android のみ。身分証明書の有効期限（秒単位）。
phone_number

string

Android の確認証明書の場合。

FinalizeMfaSignInRequest

多要素認証のチャレンジを検証して、多要素認証によるログインを完了します。

フィールド
mfa_provider

MfaProvider

必須。2 つ目の要素の種類。
mfa_pending_credential

string

必須。MFA の第 1 要素でのログインからの認証情報の保留中。
共用体フィールド verification_info。確認情報のいずれか、または確認が必要な多要素認証の登録情報に必要です。verification_info は次のいずれかになります。
phone_verification_info

FinalizeMfaPhoneRequestInfo

スマートフォン認証に固有の確認情報。

FinalizeMfaSignInResponse

FinalizeMfaSignIn レスポンス。

フィールド
id_token

string

MFA ユーザーの Firebase ID トークン。
refresh_token

string

MFA ユーザーの更新トークン。MFA ID トークンを取得します。
共用体フィールド auxiliary_auth_info。多要素認証で確認されたログイン情報。auxiliary_auth_info は次のいずれかになります。
phone_auth_info

FinalizeMfaPhoneResponseInfo

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

MfaProvider

mfa に使用する認証のタイプ。

列挙型
MFA_PROVIDER_UNSPECIFIED デフォルト値。使用しないでください。
PHONE_SMS 電話認証。

StartMfaEnrollmentRequest

ユーザーの MFA 登録確認 SMS を送信します。

フィールド
id_token

string

必須。認証済みユーザーを示す Firebase の第 1 要素 ID トークン。
mfa_provider

MfaProvider

必須。2 つ目の要素の種類。
共用体フィールド enrollment_info。必須。第 2 要素の種類別の多要素認証情報。enrollment_info は次のいずれかになります。
phone_enrollment_info

StartMfaPhoneRequestInfo

スマートフォン認証に固有のログイン情報。

StartMfaEnrollmentResponse

StartMfaEnrollment レスポンス。

フィールド
共用体フィールド enrollment_response。2 番目の要素の種類別の多要素認証の開始登録レスポンス。enrollment_response は次のいずれかになります。
phone_session_info

StartMfaPhoneResponseInfo

スマートフォン認証に固有の登録レスポンス情報。

StartMfaPhoneRequestInfo

スマートフォン認証に固有の Mfa リクエスト情報。

フィールド
phone_number

string

登録の際に必須です。MFA として登録する電話番号。
ios_receipt

string

iOS のみ。APNS によるアプリトークンの検証が成功したことの通知。
ios_secret

string

iOS のみ。APNS を介して iOS アプリに配信されるシークレット。
recaptcha_token

string

ウェブのみ。Recaptcha ソリューション。
auto_retrieval_info

AutoRetrievalInfo

Android のみ。Google Play 開発者サービスが自動取得するアプリを識別するために使用されます。
safety_net_token

string

Android のみ。recaptcha トークンの代わりにアプリケーション ID をアサートするために使用されます。SafetyNet トークンは、SafetyNet Android Attestation API を使用して生成できます。この場合、phone_number フィールドの Base64 エンコードがノンスとして使用されます。

StartMfaPhoneResponseInfo

電話認証に固有の mfa レスポンス情報。

フィールド
session_info

string

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

StartMfaSignInRequest

多要素認証のチャレンジを送信して、多要素ログインを開始します。

フィールド
mfa_provider

MfaProvider

必須。多要素の種類。
mfa_pending_credential

string

必須。MFA の第 1 要素でのログインからの認証情報の保留中。
mfa_enrollment_id

string

必須。第 1 要素でのログイン時の MFA 登録 ID。
共用体フィールド sign_in_info。電話のログイン情報のいずれかについて必須です。第 2 要素の種類別の多要素認証情報。sign_in_info は次のいずれかになります。
phone_sign_in_info

StartMfaPhoneRequestInfo

スマートフォン認証に固有のログイン情報。

StartMfaSignInResponse

StartMfaSignIn レスポンス。

フィールド
共用体フィールド response_info。第 2 要素の種類による多要素ログイン開始レスポンス。response_info は次のいずれかになります。
phone_response_info

StartMfaPhoneResponseInfo

スマートフォン認証に固有のレスポンス情報。

WithdrawMfaRequest

MultiFactorAuth を撤回します。

フィールド
id_token

string

必須。認証済みユーザーを示す Firebase MFA ID トークン。
mfa_enrollment_id

string

必須。GetAccountInfo の確認済み MFA リストの MFA 登録 ID。

WithdrawMfaResponse

MultiFactorAuth レスポンスを撤回します。

フィールド
id_token

string

最初のログイン要素の Firebase ID トークン。
refresh_token

string

最初のログイン要素の Firebase 更新トークン。