Package google.cloud.identitytoolkit.v2alpha1

索引

AccountManagementService

Identity Toolkit 的账号管理

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

为用户注册电话号码作为多重身份验证因素。

授权范围

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

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

授权范围

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

撤消用户的一项多重身份验证

授权范围

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

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

字段
app_signature_hash

string

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

FinalizeMfaEnrollmentRequest

为用户注册电话号码作为多重身份验证因素。

字段
id_token

string

必需。用于指示已通过身份验证的用户的 Firebase 第一重身份验证 ID 令牌。

mfa_provider

MfaProvider

必需。第二重身份验证类型。

display_name

string

显示名称由用户输入,用于区分具有相同类型或不同类型的不同多重身份验证因素。

联合字段 verification_info。必需。需要验证的多重身份验证注册信息。verification_info 只能是下列其中一项:
phone_verification_info

FinalizeMfaPhoneRequestInfo

电话身份验证专用验证信息。

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment 响应。

字段
id_token

string

适用于多重身份验证用户的 Firebase ID 令牌。

refresh_token

string

用于获取 MFA ID 令牌的 MFA 用户刷新令牌。

联合字段 auxiliary_auth_info。经过多重身份验证的注册信息。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

必需。第二重身份验证类型。

mfa_pending_credential

string

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

联合字段 verification_info。必须提供其中一种验证信息。需要验证的多重身份验证注册信息。verification_info 只能是下列其中一项:
phone_verification_info

FinalizeMfaPhoneRequestInfo

电话身份验证专用验证信息。

FinalizeMfaSignInResponse

FinalizeMfaSignIn 响应。

字段
id_token

string

适用于多重身份验证用户的 Firebase ID 令牌。

refresh_token

string

用于获取 MFA ID 令牌的 MFA 用户刷新令牌。

联合字段 auxiliary_auth_info。已通过多重身份验证的登录信息。auxiliary_auth_info 只能是下列其中一项:
phone_auth_info

FinalizeMfaPhoneResponseInfo

特定于电话身份验证的辅助身份验证信息。

MfaProvider

要用于多重身份验证的身份验证类型。

枚举
MFA_PROVIDER_UNSPECIFIED 默认值。请勿使用。
PHONE_SMS 手机身份验证。

StartMfaEnrollmentRequest

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

字段
id_token

string

必需。用于指示已通过身份验证的用户的 Firebase 第一重身份验证 ID 令牌。

mfa_provider

MfaProvider

必需。第二重身份验证类型。

联合字段 enrollment_info。必需。按第二重身份验证方式类型显示的多重身份验证信息。enrollment_info 只能是下列其中一项:
phone_enrollment_info

StartMfaPhoneRequestInfo

电话身份验证专用登录信息。

StartMfaEnrollmentResponse

StartMfaEnrollment 响应。

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

StartMfaPhoneResponseInfo

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

StartMfaPhoneRequestInfo

特定于手机身份验证的 Mfa 请求信息。

字段
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。

StartMfaPhoneResponseInfo

特定于手机身份验证的 Mfa 响应信息。

字段
session_info

string

表示注册会话的不透明字符串。

StartMfaSignInRequest

通过发送多重身份验证质询来启动多重身份验证登录。

字段
mfa_provider

MfaProvider

必需。多重身份验证类型。

mfa_pending_credential

string

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

mfa_enrollment_id

string

必需。第一重身份验证登录时的多重身份验证注册 ID。

联合字段 sign_in_info。电话登录信息之一必须提供此信息。按第二重身份验证类型提供多重身份验证信息。sign_in_info 只能是下列其中一项:
phone_sign_in_info

StartMfaPhoneRequestInfo

电话身份验证专用登录信息。

StartMfaSignInResponse

StartMfaSignIn 响应。

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

StartMfaPhoneResponseInfo

特定于手机身份验证的响应信息。

WithdrawMfaRequest

撤消了 MultiFactorAuth。

字段
id_token

string

必需。用于指示经过身份验证的用户的 Firebase 多重身份验证 ID 令牌。

mfa_enrollment_id

string

必需。来自 GetAccountInfo 的经过验证的 MFA 列表中的 MFA 注册 ID。

WithdrawMfaResponse

撤消 MultiFactorAuth 响应。

字段
id_token

string

用于第一重登录因素的 Firebase ID 令牌。

refresh_token

string

用于第一重登录因素的 Firebase 刷新令牌。