Package google.cloud.identitytoolkit.v2

インデックス

AccountManagementService

Identity Toolkit のアカウント管理

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

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

認可スコープ

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

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

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

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

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

認可スコープ

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

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

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

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

アカウントに登録されている第 2 要素から 1 つの第 2 要素を取り消します。

認可スコープ

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

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

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

AuthenticationService

Identity Toolkit の認証

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

MFA チャレンジを検証してログインを実行する

認可スコープ

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

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

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

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

プロジェクトまたはテナントで設定されたパスワード ポリシー構成を取得します。

認可スコープ

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

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

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

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

reCAPTCHA 分析に必要なパラメータを取得します。

認可スコープ

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

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

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

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

ID プロバイダ（IdP）からユーザーのトークンを取り消します。これは、IdP 認証情報と、取り消し用のトークンタイプを手動で指定することで行います。

Google Cloud プロジェクトを識別するには、リクエストに API キーが必要です。

認可スコープ

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

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

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

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

MFA チャレンジを送信します

認可スコープ

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

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

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

AutoRetrievalInfo

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

フィールド
app_signature_hash

string

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

ClientType

クライアントのプラットフォーム タイプ: ウェブ、Android、iOS。

列挙型
CLIENT_TYPE_UNSPECIFIED クライアントの種類が指定されていません。
CLIENT_TYPE_WEB クライアント タイプはウェブです。
CLIENT_TYPE_ANDROID クライアントの種類は Android です。
CLIENT_TYPE_IOS クライアントの種類は ios です。

FinalizeMfaEnrollmentRequest

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

フィールド
id_token

string

必須。ID トークン。
display_name

string

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

string

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

FinalizeMfaPhoneRequestInfo

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

FinalizeMfaTotpEnrollmentRequestInfo

TOTP の確認情報。

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment レスポンス。

フィールド
id_token

string

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

string

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

FinalizeMfaPhoneResponseInfo

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

FinalizeMfaTotpEnrollmentResponseInfo

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

FinalizeMfaPhoneRequestInfo

FinalizeMfa リクエストの電話確認情報。

フィールド
session_info

string

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

string

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

string

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

string

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

FinalizeMfaPhoneResponseInfo

FinalizeMfa レスポンスの電話認証情報。

フィールド
android_verification_proof

string

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

Timestamp

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

string

Android の確認証明書の場合。

FinalizeMfaSignInRequest

MFA チャレンジを検証してログインを完了します。

フィールド
mfa_pending_credential

string

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

string

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

string

ユーザーの現在の MFA 登録リストにある MFA 登録 ID。
共用体フィールド verification_info。MFA チャレンジの完了証明書。verification_info は次のいずれかになります。
phone_verification_info

FinalizeMfaPhoneRequestInfo

SMS ベースの MFA チャレンジの完了を証明する書類。
totp_verification_info

MfaTotpSignInRequestInfo

TOTP ベースの MFA チャレンジの完了を証明する書類。

FinalizeMfaSignInResponse

FinalizeMfaSignIn レスポンス。

フィールド
id_token

string

認証されたユーザーの ID トークン。
refresh_token

string

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

FinalizeMfaPhoneResponseInfo

Android の確認証明書など、スマートフォンの追加認証情報。

FinalizeMfaTotpEnrollmentRequestInfo

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

フィールド
session_info

string

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

string

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

FinalizeMfaTotpEnrollmentResponseInfo

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

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

GetPasswordPolicyRequest

GetPasswordPolicy のリクエスト。

フィールド
tenant_id

string

テナントの ID。

GetRecaptchaConfigRequest

GetRecaptchaConfig のリクエスト。

フィールド
tenant_id

string

テナントの ID。
client_type

ClientType

reCAPTCHA Enterprise では、クライアントの種類ごとに個別のサイトキーを使用します。クライアント タイプを指定して、対応するキーを取得します。
version

RecaptchaVersion

reCAPTCHA のバージョン。

MfaTotpSignInRequestInfo

FinalizeMfaSignInRequest の TOTP 確認情報。

フィールド
verification_code

string

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

PasswordPolicy

パスワード ポリシーの構成。

フィールド
custom_strength_options

CustomStrengthOptions

パスワード ポリシーによって適用されるカスタム強度オプション。
schema_version

int32

出力専用。パスワード ポリシーのスキーマ バージョン番号
allowed_non_alphanumeric_characters[]

string

出力専用。non_alphanumeric の要件を満たす許可された文字。
enforcement_state

EnforcementState

出力専用。パスワード ポリシーに使用する適用モード。
force_upgrade_on_signin

bool

ログインするには、パスワード ポリシーに準拠したパスワードが必要です。

CustomStrengthOptions

ユーザーのパスワードに適用するカスタム強度オプション。

フィールド
min_password_length

int32

最小パスワード長。範囲は 6 ～ 30
max_password_length

int32

パスワードの最大文字数。デフォルトの最大長なし
contains_lowercase_character

bool

パスワードには小文字を含める必要があります。
contains_uppercase_character

bool

パスワードには大文字を含める必要があります。
contains_numeric_character

bool

パスワードには数字を含める必要があります。
contains_non_alphanumeric_character

bool

パスワードには英数字以外の文字を含める必要があります。

EnforcementState

パスワード ポリシーの適用状態

列挙型
ENFORCEMENT_STATE_UNSPECIFIED 違反措置のステータスが設定されていません。
OFF プロジェクトでパスワード ポリシーは使用されません。
ENFORCE パスワード ポリシーに準拠していないパスワードは拒否され、エラーがスローされます。

RecaptchaConfig

reCAPTCHA の構成

フィールド
recaptcha_enforcement_state[]

RecaptchaEnforcementState

GCIP が reCAPTCHA 保護をサポートしているプロバイダの reCAPTCHA 適用ステータス。
recaptcha_key

string

reCAPTCHA Enterprise キーのリソース名（例: "projects/{project}/keys/{key}"）。これは、少なくとも 1 つの reCAPTCHA プロバイダで reCAPTCHA の適用ステータスが AUDIT または ENFORCE の場合にのみ返されます。
use_sms_bot_score

bool

reCAPTCHA 電話プロバイダの rCE bot スコアを使用するかどうか。
use_sms_toll_fraud_protection

bool

reCAPTCHA の電話プロバイダに rCE SMS 通信不正利用防止リスクスコアを使用するかどうか。

RecaptchaEnforcementState

reCAPTCHA 保護の適用状態。

フィールド
provider

RecaptchaProvider

reCAPTCHA 保護を提供するプロバイダ。
enforcement_state

EnforcementState

プロバイダの reCAPTCHA 適用ステータス。

EnforcementState

プロバイダごとの reCAPTCHA 保護の適用状態。

列挙型
ENFORCEMENT_STATE_UNSPECIFIED 違反措置のステータスが設定されていません。
OFF 適用なし。
AUDIT reCAPTCHA 評価が作成され、結果が適用に使用されません。
ENFORCE reCAPTCHA 評価が作成され、その結果が適用に使用されます。

RecaptchaProvider

reCAPTCHA 保護をサポートする GCIP プロバイダ。

列挙型
RECAPTCHA_PROVIDER_UNSPECIFIED reCAPTCHA プロバイダが指定されていません
EMAIL_PASSWORD_PROVIDER メール パスワード プロバイダ
PHONE_PROVIDER 電話認証プロバイダ

RecaptchaVersion

reCAPTCHA のバージョン。

列挙型
RECAPTCHA_VERSION_UNSPECIFIED reCAPTCHA のバージョンが指定されていません。
RECAPTCHA_ENTERPRISE reCAPTCHA Enterprise。

RevokeTokenRequest

RevokeToken のリクエスト メッセージ。

フィールド
provider_id

string

必須。トークンの IDP プロバイダ。現在のところ、Apple Idp のみをサポートしています。形式は「apple.com」にする必要があります。
token_type

TokenType

必須。取り消すトークンのタイプ。
token

string

必須。取り消すトークン。authorization_code が渡された場合、API はまずコードをアクセス トークンと交換し、交換したトークンを取り消します。
id_token

string

必須。アカウントをリンクする有効な Identity Platform ID トークン。アカウントでトークンの取り消しリクエストが成功し、取り消し後にトークンが生成されなかった場合、重複するリクエストは無視され、直ちに返されます。
tenant_id

string

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

string

クライアントが IdP に対して行った最初の認可リクエストで指定されたリダイレクト URI。URI には HTTPS プロトコルを使用し、ドメイン名を含める必要があります。IP アドレスや localhost を含めることはできません。token_type が CODE の場合は必須です。

TokenType

取り消すトークンのタイプ。

列挙型
TOKEN_TYPE_UNSPECIFIED デフォルト値。使用しないでください。
REFRESH_TOKEN トークンタイプは refresh_token です。
ACCESS_TOKEN トークンタイプは access_token です。
CODE トークンタイプは authorization_code です。

RevokeTokenResponse

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

RevokeToken のレスポンス メッセージ。現時点では空です。

StartMfaEnrollmentRequest

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

フィールド
id_token

string

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

string

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

StartMfaPhoneRequestInfo

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

StartMfaTotpEnrollmentRequestInfo

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

StartMfaEnrollmentResponse

StartMfaEnrollment レスポンス。

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

StartMfaPhoneResponseInfo

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

StartMfaTotpEnrollmentResponseInfo

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

StartMfaPhoneRequestInfo

StartMfa リクエストのアプリ確認情報。

フィールド
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 エンコードがノンスとして使用されます。
play_integrity_token

string

Android のみ。recaptcha トークン（またはセーフティ ネット トークン）の代わりにアプリケーション ID をアサートするために使用されます。Play Integrity トークンは、PlayIntegrity API を使用して、phone_number フィールドにノンスとして SHA256 を適用することで生成できます。
captcha_response

string

reCAPTCHA クライアントサイド統合によって提供される reCAPTCHA Enterprise トークン。reCAPTCHA Enterprise が有効になっている場合は必須です。
client_type

ClientType

クライアントの種類（web、android、ios）。reCAPTCHA Enterprise が有効になっている場合に必須です。
recaptcha_version

RecaptchaVersion

captcha_response 内の reCAPTCHA トークンの reCAPTCHA バージョン。reCAPTCHA Enterprise が有効になっている場合に必須です。

StartMfaPhoneResponseInfo

StartMfa レスポンスの電話によるオーナー確認情報。

フィールド
session_info

string

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

StartMfaSignInRequest

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

フィールド
mfa_pending_credential

string

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

string

必須。ユーザーの現在の MFA 登録のリストにある MFA 登録 ID。
tenant_id

string

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

StartMfaPhoneRequestInfo

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

StartMfaSignInResponse

StartMfaSignIn レスポンス。

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

StartMfaPhoneResponseInfo

SMS タイプの第 2 要素に固有の多要素認証ログイン セッション情報。送信された SMS から取得したワンタイム コードとともに、このセッション情報の内容を FinalizeMfaSignIn に渡して、ログインを完了する必要があります。

StartMfaTotpEnrollmentRequestInfo

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

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

StartMfaTotpEnrollmentResponseInfo

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

フィールド
shared_secret_key

string

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

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

int32

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

string

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

int32

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

string

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

Timestamp

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

WithdrawMfaRequest

MFA を撤回します。

フィールド
id_token

string

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

string

必須。現在の MFA 登録の MFA 登録 ID。
tenant_id

string

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

WithdrawMfaResponse

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

フィールド
id_token

string

第 2 要素の削除を反映して ID トークンが更新されました。
refresh_token

string

2 つ目の認証要素の削除を反映して更新トークンが更新されました。