Package google.cloud.identitytoolkit.v2

索引

AccountManagementService

Identity Toolkit 的账号管理

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

为用户完成注册第二重身份验证。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。
StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

多重身份验证 (MFA) 注册流程的第一步。对于短信验证，系统会向用户发送短信验证码。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。
WithdrawMfa

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

撤消账号已注册的第二重身份验证中的某个第二重身份验证。

授权范围

需要以下 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)

从身份提供方 (IdP) 撤消用户的令牌。为此，您需要手动提供 IdP 凭据以及要撤消的令牌类型。

请求中必须包含 API 密钥，以便识别 Google Cloud 项目。

授权范围

需要以下 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

自动检索短信所需的信息。

字段
app_signature_hash

string

Google Play 服务的 SMS Retriever API 的 Android 应用签名哈希。

ClientType

客户端的平台类型：网站、Android 或 iOS。

枚举
CLIENT_TYPE_UNSPECIFIED 未指定客户端类型。
CLIENT_TYPE_WEB 客户端类型为 Web。
CLIENT_TYPE_ANDROID 客户端类型为 Android。
CLIENT_TYPE_IOS 客户端类型为 ios。

FinalizeMfaEnrollmentRequest

为用户完成注册第二重身份验证。

字段
id_token

string

必需。ID 令牌。
display_name

string

显示名称由用户输入，用于区分同类型或不同类型的不同第二重身份验证方式。
tenant_id

string

注册多重身份验证的用户所属的 Identity Platform 租户的 ID。如果未设置，则用户属于默认的 Identity Platform 项目。
联合字段 verification_info。要验证的多重身份验证 (MFA) 注册信息。verification_info 只能是下列其中一项：
phone_verification_info

FinalizeMfaPhoneRequestInfo

用于授权发送短信以进行电话验证的验证信息。
totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

TOTP 的验证信息。

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment 响应。

字段
id_token

string

更新了身份令牌以反映多重身份验证注册。
refresh_token

string

刷新令牌已更新，以反映多重身份验证注册。
联合字段 auxiliary_auth_info。通过多重身份验证验证的注册信息。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_pending_credential

string

必需。第一重身份验证登录的凭据待处理。
tenant_id

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录默认的 Identity Platform 项目。
mfa_enrollment_id

string

用户当前 MFA 注册列表中的 MFA 注册 ID。
联合字段 verification_info。完成多重身份验证 (MFA) 质询的证明。verification_info 只能是下列其中一项：
phone_verification_info

FinalizeMfaPhoneRequestInfo

完成基于短信的 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}”。只有当至少一个 reCAPTCHA 提供方的 reCAPTCHA 强制执行状态为“审核”或“强制执行”时，才会返回此值。
use_sms_bot_score

bool

是否为 reCAPTCHA 电话号码提供商使用 rCE 聊天机器人得分。
use_sms_toll_fraud_protection

bool

是否为 reCAPTCHA 电话提供商使用 rCE 短信话费欺诈防护风险评分。

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

为用户发送多重身份验证注册验证短信。

字段
id_token

string

必需。用户的 ID 令牌。
tenant_id

string

注册多重身份验证的用户所属的 Identity Platform 租户的 ID。如果未设置，则用户属于默认的 Identity Platform 项目。
联合字段 enrollment_info。按第二重身份验证类型显示的 MFA 信息。enrollment_info 只能是下列其中一项：
phone_enrollment_info

StartMfaPhoneRequestInfo

用于授权发送短信以进行电话验证的验证信息。
totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

特定于 TOTP 身份验证的登录信息。

StartMfaEnrollmentResponse

StartMfaEnrollment 响应。

字段
联合字段 enrollment_response。按第二重身份验证类型显示的多重身份验证开始注册响应。enrollment_response 只能是下列其中一项：
phone_session_info

StartMfaPhoneResponseInfo

用于授权发送短信以进行电话验证的验证信息。
totp_session_info

StartMfaTotpEnrollmentResponseInfo

特定于 TOTP 身份验证的注册响应信息。

StartMfaPhoneRequestInfo

StartMfa 请求的应用验证信息。

字段
phone_number

string

注册时必需。要注册为多重身份验证 (MFA) 的电话号码。
ios_receipt

string

仅限 iOS 设备。收到通过 APNS 成功验证应用令牌的通知。
ios_secret

string

仅限 iOS 设备。通过 APNS 传送到 iOS 应用的 Secret。
recaptcha_token

string

仅限网页。reCAPTCHA 解决方案。
auto_retrieval_info

AutoRetrievalInfo

仅限 Android 设备。供 Google Play 服务用于识别要自动检索的应用。
safety_net_token

string

仅限 Android 设备。用于声明应用身份，取代 reCAPTCHA 令牌。您可以通过 SafetyNet Android Attestation API 生成 SafetyNet 令牌，并将 phone_number 字段的 Base64 编码用作 Nonce。
play_integrity_token

string

仅限 Android 设备。用于声明应用身份，取代 reCAPTCHA 令牌（或安全网令牌）。您可以通过 PlayIntegrity API 生成 Play Integrity 令牌，方法是将 SHA256 应用于 phone_number 字段作为 Nonce。
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

必需。第一重身份验证登录的凭据待处理。
mfa_enrollment_id

string

必需。用户当前 MFA 注册列表中的 MFA 注册 ID。
tenant_id

string

用户登录的 Identity Platform 租户的 ID。如果未设置，用户将登录默认的 Identity Platform 项目。
联合字段 sign_in_info。按第二重身份验证类型显示的 MFA 信息。sign_in_info 只能是下列其中一项：
phone_sign_in_info

StartMfaPhoneRequestInfo

用于授权发送短信以进行电话验证的验证信息。

StartMfaSignInResponse

StartMfaSignIn 响应。

字段
联合字段 response_info。按第二重身份验证类型显示多重身份验证登录开始响应。response_info 只能是下列其中一项：
phone_response_info

StartMfaPhoneResponseInfo

特定于短信类型第二重身份验证的多重身份验证登录会话信息。除了从发送的短信中检索到的一次性验证码之外，此会话信息的内容应传递给 FinalizeMfaSignIn 以完成登录。

StartMfaTotpEnrollmentRequestInfo

此类型没有字段。

特定于 StartMfa 的 TOTP 身份验证的 Mfa 请求信息。

StartMfaTotpEnrollmentResponseInfo

特定于 StartMfa 的 TOTP 身份验证的 Mfa 响应信息。

字段
shared_secret_key

string

一个以 base 32 编码的字符串，表示共享的 TOTP 密钥。

采用的是 RFC4648#section-6 中指定的基于 32 的编码。（这与 RFC3548#section-5 中的 base 32 编码相同）。
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

用户取消注册多重身份验证所属的 Identity Platform 租户的 ID。如果未设置，则用户属于默认的 Identity Platform 项目。

WithdrawMfaResponse

撤消 MultiFactorAuth 响应。

字段
id_token

string

更新了 ID 令牌，以反映已移除第二重身份验证。
refresh_token

string

刷新令牌已更新，以反映第二重身份验证已移除。