Package google.cloud.identitytoolkit.v2alpha1

索引

• AccountManagementService (介面)
• AuthenticationV2Alpha1Service (介面)
• AutoRetrievalInfo (訊息)
• FinalizeMfaEnrollmentRequest (訊息)
• FinalizeMfaEnrollmentResponse (訊息)
• FinalizeMfaPhoneRequestInfo (訊息)
• FinalizeMfaPhoneResponseInfo (訊息)
• FinalizeMfaSignInRequest (訊息)
• FinalizeMfaSignInResponse (訊息)
• MfaProvider (enum)
• StartMfaEnrollmentRequest (訊息)
• StartMfaEnrollmentResponse (訊息)
• StartMfaPhoneRequestInfo (訊息)
• StartMfaPhoneResponseInfo (訊息)
• StartMfaSignInRequest (訊息)
• StartMfaSignInResponse (訊息)
• WithdrawMfaRequest (訊息)
• WithdrawMfaResponse (訊息)

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) 撤銷使用者的 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

自動擷取簡訊所需的資訊。

欄位
app_signature_hash	string Android 應用程式針對 Google Play 服務的 SMS Retriever API 所用的簽署雜湊。

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 使用者取得 MFA ID 權杖的重新整理權杖。
聯集欄位 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 使用者取得 MFA ID 權杖的重新整理權杖。
聯集欄位 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。這是必要旗標，依據 2 項因素類型提供多重驗證資訊。enrollment_info 只能是下列其中一項：
phone_enrollment_info	StartMfaPhoneRequestInfo 電話驗證專用的登入資訊。

StartMfaEnrollmentResponse

StartMfaEnrollment 回應。

欄位
聯集欄位 enrollment_response。多重驗證開始註冊回應，並依據第 2 種驗證類型。enrollment_response 只能是下列其中一項：
phone_session_info	StartMfaPhoneResponseInfo 電話驗證專屬的註冊回應資訊。

StartMfaPhoneRequestInfo

針對電話驗證的 Mfa 要求資訊。

欄位
phone_number	string 註冊作業的必要項目，要註冊為多重身份驗證的電話號碼。
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 權杖，宣告應用程式身分。您可以透過 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。必須提供其中一種電話登入資訊。多重驗證資訊，按 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 重新整理權杖。