Package google.cloud.identitytoolkit.v2beta1

索引

• ProjectConfigService (介面)
• TenantManagementService (介面)
• BlockingFunctionsConfig (訊息)
• BlockingFunctionsConfig.Trigger (訊息)
• ClientConfig (訊息)
• ClientConfig.Permissions (訊息)
• Config (訊息)
• Config.Subtype (enum)
• CreateDefaultSupportedIdpConfigRequest (訊息)
• CreateInboundSamlConfigRequest (訊息)
• CreateOAuthIdpConfigRequest (訊息)
• CreateTenantRequest (訊息)
• DefaultSupportedIdp (訊息)
• DefaultSupportedIdpConfig (訊息)
• DeleteDefaultSupportedIdpConfigRequest (訊息)
• DeleteInboundSamlConfigRequest (訊息)
• DeleteOAuthIdpConfigRequest (訊息)
• DeleteTenantRequest (訊息)
• EnableCicpRequest (訊息)
• EnableCicpResponse (訊息)
• GetConfigRequest (訊息)
• GetDefaultSupportedIdpConfigRequest (訊息)
• GetInboundSamlConfigRequest (訊息)
• GetOAuthIdpConfigRequest (訊息)
• GetTenantRequest (訊息)
• HashConfig (訊息)
• HashConfig.HashAlgorithm (enum)
• IdpCertificate (訊息)
• InboundSamlConfig (訊息)
• InboundSamlConfig.IdpConfig (訊息)
• InboundSamlConfig.SpConfig (訊息)
• ListDefaultSupportedIdpConfigsRequest (訊息)
• ListDefaultSupportedIdpConfigsResponse (訊息)
• ListDefaultSupportedIdpsRequest (訊息)
• ListDefaultSupportedIdpsResponse (訊息)
• ListInboundSamlConfigsRequest (訊息)
• ListInboundSamlConfigsResponse (訊息)
• ListOAuthIdpConfigsRequest (訊息)
• ListOAuthIdpConfigsResponse (訊息)
• ListTenantsRequest (訊息)
• ListTenantsResponse (訊息)
• MonitoringConfig (訊息)
• MonitoringConfig.RequestLogging (訊息)
• MultiFactorAuthConfig (訊息)
• MultiFactorAuthConfig.Provider (enum)
• MultiFactorAuthConfig.State (enum)
• NotificationConfig (訊息)
• NotificationConfig.SendEmail (訊息)
• NotificationConfig.SendEmail.DnsInfo (訊息)
• NotificationConfig.SendEmail.DnsInfo.VerificationState (enum)
• NotificationConfig.SendEmail.EmailTemplate (訊息)
• NotificationConfig.SendEmail.EmailTemplate.BodyFormat (enum)
• NotificationConfig.SendEmail.Method (enum)
• NotificationConfig.SendEmail.Smtp (訊息)
• NotificationConfig.SendEmail.Smtp.SecurityMode (enum)
• NotificationConfig.SendSms (訊息)
• NotificationConfig.SendSms.SmsTemplate (訊息)
• OAuthIdpConfig (訊息)
• OAuthIdpConfig.OAuthResponseType (訊息)
• QuotaConfig (訊息)
• QuotaConfig.TemporaryQuota (訊息)
• SignInConfig (訊息)
• SignInConfig.Anonymous (訊息)
• SignInConfig.Email (訊息)
• SignInConfig.PhoneNumber (訊息)
• SpCertificate (訊息)
• Tenant (訊息)
• UpdateConfigRequest (訊息)
• UpdateDefaultSupportedIdpConfigRequest (訊息)
• UpdateInboundSamlConfigRequest (訊息)
• UpdateOAuthIdpConfigRequest (訊息)
• UpdateTenantRequest (訊息)
• VerifyDomainRequest (訊息)
• VerifyDomainRequest.DomainVerificationAction (enum)
• VerifyDomainResponse (訊息)

ProjectConfigService

Identity Toolkit 的專案設定

CreateDefaultSupportedIdpConfig
rpc CreateDefaultSupportedIdpConfig(CreateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig) 為 Identity Toolkit 專案建立支援的預設 IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

CreateInboundSamlConfig
rpc CreateInboundSamlConfig(CreateInboundSamlConfigRequest) returns (InboundSamlConfig) 為 Identity Toolkit 專案建立傳入 SAML 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

CreateOAuthIdpConfig
rpc CreateOAuthIdpConfig(CreateOAuthIdpConfigRequest) returns (OAuthIdpConfig) 為 Identity Toolkit 專案建立 Oidc IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

DeleteDefaultSupportedIdpConfig
rpc DeleteDefaultSupportedIdpConfig(DeleteDefaultSupportedIdpConfigRequest) returns (Empty) 刪除 Identity Toolkit 專案的預設支援 IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

DeleteInboundSamlConfig
rpc DeleteInboundSamlConfig(DeleteInboundSamlConfigRequest) returns (Empty) 刪除 Identity Toolkit 專案的傳入 SAML 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

DeleteOAuthIdpConfig
rpc DeleteOAuthIdpConfig(DeleteOAuthIdpConfigRequest) returns (Empty) 刪除 Identity Toolkit 專案的 Oidc IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

EnableCicp
rpc EnableCicp(EnableCicpRequest) returns (EnableCicpResponse) 為 Cloud 專案啟用 CICP。客戶和合作夥伴專用的 Cloud Identity (CICP) 是一套端對端驗證系統，可讓第三方使用者存取您的應用程式和服務。包括行動/網頁應用程式、遊戲、API 等。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

GetConfig
rpc GetConfig(GetConfigRequest) returns (Config) 擷取 Identity Toolkit 專案設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

GetDefaultSupportedIdpConfig
rpc GetDefaultSupportedIdpConfig(GetDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig) 擷取 Identity Toolkit 專案的預設支援 IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

GetInboundSamlConfig
rpc GetInboundSamlConfig(GetInboundSamlConfigRequest) returns (InboundSamlConfig) 擷取 Identity Toolkit 專案的傳入 SAML 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

GetOAuthIdpConfig
rpc GetOAuthIdpConfig(GetOAuthIdpConfigRequest) returns (OAuthIdpConfig) 擷取 Identity Toolkit 專案的 Oidc IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

ListDefaultSupportedIdpConfigs
rpc ListDefaultSupportedIdpConfigs(ListDefaultSupportedIdpConfigsRequest) returns (ListDefaultSupportedIdpConfigsResponse) 列出 Identity Toolkit 專案的所有預設支援 IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

ListDefaultSupportedIdps
rpc ListDefaultSupportedIdps(ListDefaultSupportedIdpsRequest) returns (ListDefaultSupportedIdpsResponse) 列出所有預設支援的 Idp。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

ListInboundSamlConfigs
rpc ListInboundSamlConfigs(ListInboundSamlConfigsRequest) returns (ListInboundSamlConfigsResponse) 列出 Identity Toolkit 專案的所有傳入 SAML 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

ListOAuthIdpConfigs
rpc ListOAuthIdpConfigs(ListOAuthIdpConfigsRequest) returns (ListOAuthIdpConfigsResponse) 列出 Identity Toolkit 專案的所有 Oidc IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

UpdateConfig
rpc UpdateConfig(UpdateConfigRequest) returns (Config) 更新 Identity Toolkit 專案設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

UpdateDefaultSupportedIdpConfig
rpc UpdateDefaultSupportedIdpConfig(UpdateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig) 更新 Identity Toolkit 專案的預設支援 IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

UpdateInboundSamlConfig
rpc UpdateInboundSamlConfig(UpdateInboundSamlConfigRequest) returns (InboundSamlConfig) 更新 Identity Toolkit 專案的傳入 SAML 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

UpdateOAuthIdpConfig
rpc UpdateOAuthIdpConfig(UpdateOAuthIdpConfigRequest) returns (OAuthIdpConfig) 更新 Identity Toolkit 專案的 Oidc IdP 設定。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

VerifyDomain
rpc VerifyDomain(VerifyDomainRequest) returns (VerifyDomainResponse) 確認要求的自訂網域是否有必要的 DNS 記錄。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

TenantManagementService

GCIP 的租戶管理服務。

CreateTenant
rpc CreateTenant(CreateTenantRequest) returns (Tenant) 建立租戶。需要 Agent 專案的寫入權限。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

DeleteTenant
rpc DeleteTenant(DeleteTenantRequest) returns (Empty) 刪除用戶群。需要 Agent 專案的寫入權限。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

GetTenant
rpc GetTenant(GetTenantRequest) returns (Tenant) 取得用戶群。需要租用戶資源的讀取權限。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

ListTenants
rpc ListTenants(ListTenantsRequest) returns (ListTenantsResponse) 列出指定代理程式專案下的租戶。需要 Agent 專案的讀取權限。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

UpdateTenant
rpc UpdateTenant(UpdateTenantRequest) returns (Tenant) 更新租用戶。需要租用戶資源的寫入權限。 授權範圍 需要下列其中一種 OAuth 範圍： https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform 詳情請參閱 Authentication Overview。

BlockingFunctionsConfig

與封鎖函式相關的設定。

欄位
triggers	map<string, Trigger> 觸發事件與事件類型的對應表。鍵應為支援的事件類型之一：「beforeCreate」、「beforeSignIn」

觸發條件

使用 HTTP 觸發條件的同步 Cloud 函式

欄位
function_uri	string Cloud 函式的 HTTP URI 觸發條件。
update_time	Timestamp 觸發條件變更的時間。

ClientConfig

與用戶端代替專案提出要求的設定方式相關的選項。

欄位
api_key	string 僅供輸出。提出此專案要求時可使用的 API 金鑰。
permissions	Permissions 與限制使用者影響帳戶的權限相關的設定。
firebase_subdomain	string 僅供輸出。Firebase 子網域。

權限

與限制使用者影響帳戶的權限相關的設定。

欄位
disabled_user_signup	bool 如果為 True，使用者就無法透過任何 API 方法，在相關專案中註冊新帳戶
disabled_user_deletion	bool 如果為 true，使用者就無法透過任何 API 方法刪除相關專案中的帳戶

設定

代表 Identity Toolkit 專案。

欄位
name	string 僅供輸出。設定資源的名稱。例如：「projects/my-awesome-project/config」
sign_in	SignInConfig 與本機登入方法相關的設定。
notification	NotificationConfig 與傳送通知給使用者相關的設定。
quota	QuotaConfig 與配額相關的設定。
monitoring	MonitoringConfig 與監控專案活動相關的設定。
authorized_domains[]	string 已授權重新導向 OAuth 的網域清單
subtype	Subtype 僅供輸出。此設定的子類型。
client	ClientConfig 與用戶端代替專案提出要求的設定方式相關的選項。
mfa	MultiFactorAuthConfig 這個專案的多重驗證設定，包括是否啟用多重驗證，以及可用於第二因素的驗證方式
blocking_functions	BlockingFunctionsConfig 與封鎖函式相關的設定。

子類型

此設定的子類型。

列舉
SUBTYPE_UNSPECIFIED	預設值。請勿使用。
CUSTOMER_IDENTITY	客戶身分專案。
FIREBASE_AUTH	Firebase 驗證專案。

CreateDefaultSupportedIdpConfigRequest

建立預設支援的 IdP 設定要求

欄位
parent	string 要建立設定的父項資源名稱，例如：「projects/my-awesome-project」 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.update
idp_id	string 要建立設定檔的 ID。請呼叫 ListDefaultSupportedIdps，取得所有預設支援的 Idp 清單。
default_supported_idp_config	DefaultSupportedIdpConfig 取代伺服器上資源的設定資源。

CreateInboundSamlConfigRequest

CreateInboundSamlConfig 要求

欄位
parent	string 要建立設定的父項資源名稱，例如：「projects/my-awesome-project」 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.update
inbound_saml_config_id	string 要用於此設定的 ID。
inbound_saml_config	InboundSamlConfig 要建立的設定資源。用戶端不得設定 InboundSamlConfig.name 欄位，如果由用戶端設定，伺服器會忽略該欄位值。

CreateOAuthIdpConfigRequest

CreateOAuthIdpConfig 要求

欄位
parent	string 要建立設定的父項資源名稱，例如：「projects/my-awesome-project」 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.update
oauth_idp_config_id	string 要用於此設定的 ID。
oauth_idp_config	OAuthIdpConfig 要建立的設定資源。用戶端不得設定 OAuthIdpConfig.name 欄位，如果由用戶端設定，伺服器會忽略該欄位值。

CreateTenantRequest

CreateTenant 的要求訊息。

欄位
parent	string 要建立租用戶的父項資源名稱。例如「projects/project1」。 授權需要指定資源 parent 的下列 IAM 權限： identitytoolkit.tenants.create
tenant	Tenant 這是必要旗標，要建立的租用戶。

DefaultSupportedIdp

標準 Identity Toolkit 信任的 IDP。

欄位
idp_id	string Id 的 Idp
description	string IdP 說明

DefaultSupportedIdpConfig

設定選項，可透過標準 Identity Toolkit 信任的 IdP 進行驗證。

欄位
name	string DefaultSupportedIdpConfig 資源的名稱，例如：「projects/my-awesome-project/defaultSupportedIdpConfigs/google.com」
enabled	bool 如果允許使用者透過提供者登入，則值為「是」。
client_id	string OAuth 用戶端 ID。
client_secret	string OAuth 用戶端密鑰。
display_on_cloud_console	bool 僅供輸出。如果 IdP 處於停用狀態，是否要在 Pantheon 上顯示 IdP 設定。

DeleteDefaultSupportedIdpConfigRequest

要求刪除預設支援的 ID 提供者設定

欄位
name	string 設定的資源名稱，例如：「projects/my-awesome-project/defaultSupportedIdpConfigs/google.com」 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.update

DeleteInboundSamlConfigRequest

DeleteInboundSamlConfig 要求

欄位
name	string 要刪除的設定資源名稱，例如：`projects/my-awesome-project/inboundSamlConfigs/my-config-id`。 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.update

DeleteOAuthIdpConfigRequest

要求刪除 OAuthIdpConfig

欄位
name	string 要刪除的設定資源名稱，例如：`projects/my-awesome-project/oauthIdpConfigs/oauth-config-id`。 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.update

DeleteTenantRequest

DeleteTenant 的要求訊息。

欄位
name	string 要刪除的租用戶資源名稱。 授權需要指定資源 name 的下列 IAM 權限： identitytoolkit.tenants.delete

EnableCicpRequest

要求啟用 EnableCicp。

欄位
project	string 開發人員要為其啟用 CICP 的目標專案資源名稱。 授權需要指定資源 project 的下列 IAM 權限： firebaseauth.configs.create

EnableCicpResponse

這個類型沒有任何欄位。

對 EnableCicp 的回應。目前為空白。

GetConfigRequest

GetConfig 要求

欄位
name	string 設定的資源名稱，例如：「projects/my-awesome-project/config」 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.get

GetDefaultSupportedIdpConfigRequest

要求 GetDefaultSupportedIdpConfig

欄位
name	string 設定的資源名稱，例如：「projects/my-awesome-project/defaultSupportedIdpConfigs/google.com」 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.get

GetInboundSamlConfigRequest

GetInboundSamlConfig 要求

欄位
name	string 設定的資源名稱，例如：`projects/my-awesome-project/inboundSamlConfigs/my-config-id`。 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.get

GetOAuthIdpConfigRequest

GetOAuthIdpConfig 要求

欄位
name	string 設定的資源名稱，例如：`projects/my-awesome-project/oauthIdpConfigs/oauth-config-id`。 授權需要指定資源 name 的下列 IAM 權限： firebaseauth.configs.get

GetTenantRequest

GetTenant 的要求訊息。

欄位
name	string 要擷取的租用戶資源名稱。 授權需要指定資源 name 的下列 IAM 權限： identitytoolkit.tenants.get

HashConfig

雜湊演算法和金鑰的記錄資訊。不同版本可能會產生不同帳戶的密碼。

欄位
algorithm	HashAlgorithm 僅供輸出。Identity Toolkit 使用的不同密碼雜湊演算法。
signer_key	string 僅供輸出。以 Base64 編碼的簽署者金鑰。
salt_separator	string 僅供輸出。在 Base64 鹽值和純文字密碼之間插入的非顯示字元。
rounds	int32 僅供輸出。雜湊運算的輪次數。由 scrypt 和其他類似的密碼衍生演算法使用。
memory_cost	int32 僅供輸出。雜湊運算的記憶體成本。由 scrypt 和其他類似的密碼衍生演算法使用。如需欄位說明，請參閱 https://tools.ietf.org/html/rfc7914。

HashAlgorithm

Identity Toolkit 使用的不同密碼雜湊演算法。

列舉
HASH_ALGORITHM_UNSPECIFIED	預設值。請勿使用。
HMAC_SHA256	HMAC_SHA256
HMAC_SHA1	HMAC_SHA1
HMAC_MD5	HMAC_MD5
SCRYPT	SCRYPT
PBKDF_SHA1	PBKDF_SHA1
MD5	MD5
HMAC_SHA512	HMAC_SHA512
SHA1	SHA1
BCRYPT	BCRYPT
PBKDF2_SHA256	PBKDF2_SHA256
SHA256	SHA256
SHA512	SHA512
STANDARD_SCRYPT	STANDARD_SCRYPT

IdpCertificate

IDP 憑證資料的 proto，用於驗證 IDP 核發的 SAMLResponse 中的簽名。

欄位
x509_certificate	string x509 憑證

InboundSamlConfig

當專案扮演信賴方時，用於儲存一組 SAML RP-IDP 設定的 proto。

欄位
name	string InboundSamlConfig 資源的名稱，例如：`projects/my-awesome-project/inboundSamlConfigs/my-config-id`。系統會在建立要求時忽略此欄。
idp_config	IdpConfig 在專案以信賴方身分運作時，用於儲存 SAML IdP (識別資訊提供者) 設定的 proto。
sp_config	SpConfig 當專案以依賴方身分接收並接受由 SAML 身分識別資訊提供者發出的驗證斷言時，用於儲存 SAML SP (服務供應商) 設定的 proto。
display_name	string 開發人員設定的設定顯示名稱。
enabled	bool 如果允許使用者透過提供者登入，則值為「是」。

IdpConfig

在專案以信賴方身分運作時，用於儲存 SAML IdP (識別資訊提供者) 設定的 proto。

欄位
idp_entity_id	string 所有 SAML 實體的專屬 ID。
sso_url	string 要傳送驗證要求的網址。
idp_certificates[]	IdpCertificate IdP 的公開金鑰，用於驗證斷言中的簽章。
sign_request	bool 指出是否應為傳出 SAMLRequest 簽署。

SpConfig

當專案以依賴方身分接收並接受由 SAML 身分識別資訊提供者發出的驗證斷言時，用於儲存 SAML SP (服務供應商) 設定的 proto。

欄位
sp_entity_id	string 所有 SAML 實體的專屬 ID。
callback_uri	string 用於處理來自 IDP 的回應的回呼 URI。
sp_certificates[]	SpCertificate 僅供輸出。伺服器產生的公開憑證，用於驗證 SP 啟動流程中 SAMLRequest 中的簽名。

ListDefaultSupportedIdpConfigsRequest

要求 ListDefaultSupportedIdpConfigs

欄位
parent	string 父項資源名稱，例如「projects/my-awesome-project」。 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.get
page_size	int32 傳回的項目數量上限。
page_token	string 先前的 List 要求 (如果有的話) 傳回的 next_page_token 值。

ListDefaultSupportedIdpConfigsResponse

ListDefaultSupportedIdpConfigs 的回應

欄位
default_supported_idp_configs[]	DefaultSupportedIdpConfig 設定組合。
next_page_token	string 用來擷取下一頁結果的符記；如果清單中沒有其他結果，這個欄位會是空白的。

ListDefaultSupportedIdpsRequest

要求 ListDefaultSupportedIdps

欄位
page_size	int32 傳回的項目數量上限。
page_token	string 先前的 List 要求 (如果有的話) 傳回的 next_page_token 值。

ListDefaultSupportedIdpsResponse

ListDefaultSupportedIdps 的回應

欄位
default_supported_idps[]	DefaultSupportedIdp 設定組合。
next_page_token	string 用來擷取下一頁結果的符記；如果清單中沒有其他結果，這個欄位會是空白的。

ListInboundSamlConfigsRequest

要求 ListInboundSamlConfigs

欄位
parent	string 父項資源名稱，例如「projects/my-awesome-project」。 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.get
page_size	int32 傳回的項目數量上限。
page_token	string 先前的 List 要求 (如果有的話) 傳回的 next_page_token 值。

ListInboundSamlConfigsResponse

ListInboundSamlConfigs 的回應

欄位
inbound_saml_configs[]	InboundSamlConfig 設定組合。
next_page_token	string 用來擷取下一頁結果的符記；如果清單中沒有其他結果，這個欄位會是空白的。

ListOAuthIdpConfigsRequest

要求 ListOAuthIdpConfigs

欄位
parent	string 父項資源名稱，例如「projects/my-awesome-project」。 授權需要指定資源 parent 的下列 IAM 權限： firebaseauth.configs.get
page_size	int32 傳回的項目數量上限。
page_token	string 先前的 List 要求 (如果有的話) 傳回的 next_page_token 值。

ListOAuthIdpConfigsResponse

ListOAuthIdpConfigs 的回應

欄位
oauth_idp_configs[]	OAuthIdpConfig 設定組合。
next_page_token	string 用來擷取下一頁結果的符記；如果清單中沒有其他結果，這個欄位會是空白的。

ListTenantsRequest

ListTenants 的要求訊息。

欄位
parent	string 這是必要旗標，要列出租戶的父項資源名稱。 授權需要指定資源 parent 的下列 IAM 權限： identitytoolkit.tenants.list
page_token	string 先前要求回應中的分頁符記。
page_size	int32 要傳回的結果數上限為 1000 個。如未指定，則預設值為 20。

ListTenantsResponse

ListTenants 的回應訊息。

欄位
tenants[]	Tenant 指定代理程式專案下的租戶清單。
next_page_token	string 用來取得下一頁結果的符記。

MonitoringConfig

與監控專案活動相關的設定。

欄位
request_logging	RequestLogging 將對此專案提出的要求記錄到 Stackdriver Logging 的設定

RequestLogging

將對此專案提出的要求記錄到 Stackdriver Logging 的設定

欄位
enabled	bool 是否為此專案啟用記錄功能。

MultiFactorAuthConfig

與專案多重驗證相關的選項。

欄位
state	State 是否已為這個專案啟用多重驗證功能。
enabled_providers[]	Provider 這項專案可使用的第二層驗證方式清單。

供應商

這項專案可使用的第二層驗證方式清單。

列舉
PROVIDER_UNSPECIFIED	非法供應者，不應使用
PHONE_SMS	這項專案已啟用簡訊做為次要驗證方法。

狀態

是否已為這個專案啟用多重驗證功能。

列舉
STATE_UNSPECIFIED	非法狀態，不應使用。
DISABLED	這個專案無法使用多重驗證
ENABLED	這個專案可使用多重驗證
ADMIN_ENABLED	這個專案可以使用多重驗證，但只能由專案管理員設定

NotificationConfig

與傳送通知給使用者相關的設定。

欄位
send_email	SendEmail 電子郵件傳送選項。
send_sms	SendSms 簡訊傳送選項。
default_locale	string 在 IETF BCP 47 格式中，用於電子郵件和簡訊的預設語言代碼。

SendEmail

電子郵件傳送選項。

欄位
method	Method 用於傳送電子郵件的方法。
reset_password_template	EmailTemplate 密碼重設電子郵件範本
verify_email_template	EmailTemplate 驗證電子郵件地址的電子郵件範本
change_email_template	EmailTemplate 變更電子郵件的電子郵件範本
legacy_reset_password_template	EmailTemplate 舊版 Firebase V1 應用程式的重設密碼電子郵件範本。
callback_uri	string 電子郵件範本中的動作網址。
dns_info	DnsInfo 自訂網域 DNS 驗證資訊。
聯集欄位 email_provider_config。用於傳送電子郵件的電子郵件供應商設定 email_provider_config 只能是下列其中一種：
smtp	Smtp 使用自訂 SMTP 轉發服務

DnsInfo

自訂網域 DNS 驗證資訊。根據預設，系統會使用 default_domain。您可以使用 VerifyCustomDomain 設定自訂網域。

欄位
custom_domain	string 僅供輸出。已套用的已驗證自訂網域。
use_custom_domain	bool 是否要使用自訂網域。
pending_custom_domain	string 僅供輸出。要驗證的自訂網域。
custom_domain_state	VerificationState 僅供輸出。自訂網域目前的驗證狀態。只有在網域驗證成功後，系統才會使用自訂網域。
domain_verification_request_time	Timestamp 僅供輸出。目前網域驗證初始要求的時間戳記。

VerificationState

自訂網域目前的驗證狀態。

列舉
VERIFICATION_STATE_UNSPECIFIED	預設值。請勿使用。
NOT_STARTED	驗證程序尚未開始。
IN_PROGRESS	驗證程序正在進行中。
FAILED	驗證失敗。
SUCCEEDED	驗證成功，可開始套用。

EmailTemplate

電子郵件範本。標題和內文欄位可包含下列預留位置，系統會將這些預留位置替換為適當的值：%LINK% - 用於兌換傳送的 OOB 代碼的連結。%EMAIL% - 傳送電子郵件的電子郵件地址。%NEW_EMAIL% - 為帳戶設定的新電子郵件地址 (如適用)。%APP_NAME% - Google Cloud 專案的顯示名稱。%DISPLAY_NAME%：使用者的顯示名稱。

欄位
sender_local_part	string 寄件者地址的本機部分
subject	string 電子郵件主旨
sender_display_name	string 寄件者顯示名稱
body	string 電子郵件內文
body_format	BodyFormat 電子郵件內文格式
reply_to	string 回覆地址
customized	bool 僅供輸出。電子郵件內文或主旨是否為自訂內容。

BodyFormat

電子郵件內文格式

列舉
BODY_FORMAT_UNSPECIFIED	預設值。請勿使用。
PLAIN_TEXT	純文字
HTML	HTML

方法

用於傳送電子郵件的方法。

列舉
METHOD_UNSPECIFIED	未指定電子郵件方法。
DEFAULT	代表開發人員傳送電子郵件。
CUSTOM_SMTP	使用開發人員提供的 SMTP 設定傳送電子郵件。

Smtp

SMTP 轉發設定

欄位
sender_email	string SMTP 轉發服務的寄件者電子郵件地址
host	string SMTP 轉發主機
port	int32 SMTP 轉發通訊埠
username	string SMTP 轉發使用者名稱
password	string SMTP 轉發密碼
security_mode	SecurityMode SMTP 安全模式。

SecurityMode

SMTP 安全模式。

列舉
SECURITY_MODE_UNSPECIFIED	預設值。請勿使用。
SSL	SSL 模式
START_TLS	START_TLS 模式

SendSms

簡訊傳送選項。

欄位
use_device_locale	bool 是否要為簡訊使用 accept_language 標頭。
sms_template	SmsTemplate 僅供輸出。傳送簡訊時使用的範本。

SmsTemplate

傳送簡訊時使用的範本。

欄位
content	string 僅供輸出。SMS 內容。可包含下列預留位置，系統會以適當的值取代這些預留位置：%APP_NAME% - 針對 Android 或 iOS 應用程式，這是應用程式的顯示名稱。如果是網頁應用程式，則是代管應用程式的網域。%LOGIN_CODE% - 簡訊中傳送的 OOB 驗證碼。

OAuthIdpConfig

使用 OAuth IdP 驗證的設定選項。

欄位
name	string OAuthIdpConfig 資源的名稱，例如：`projects/my-awesome-project/oauthIdpConfigs/oauth-config-id`。系統會在建立要求時忽略此欄。
client_id	string OAuth 用戶端的用戶端 ID。
issuer	string 對於 OIDC IDP，為核發者 ID。
display_name	string 開發人員設定的設定顯示名稱。
enabled	bool 如果允許使用者透過提供者登入，則值為「是」。
client_secret	string OAuth 用戶端的用戶端密鑰，用於啟用 OIDC 程式碼流程。
response_type	OAuthResponseType 在 OAuth 授權流程中要求的回應類型。您可以將 id_token 或 code 設為 true，但不能兩者同時設為 true。系統尚未支援同時將兩種類型設為 true ({code: true, id_token: true})。

OAuthResponseType

在 OAuth 授權流程中要求的回應類型。您可以將 id_token 或 code 設為 true，但不能兩者同時設為 true。系統尚未支援同時將兩種類型設為 true ({code: true, id_token: true})。

如要查看回應類型與 OAuth 2.0 流程的對應關係，請參閱 https://openid.net/specs/openid-connect-core-1_0.html#Authentication。

欄位
id_token	bool 如果為 true，系統會從 IdP 的授權端點傳回 ID 權杖。
code	bool 如果為 true，系統會從 IdP 的授權端點傳回授權碼。
token (deprecated)	bool 這個項目已遭淘汰！ 請勿使用。目前不支援 token 回應類型。

QuotaConfig

與配額相關的設定。

欄位
sign_up_quota_config	TemporaryQuota 註冊端點的配額 (如果覆寫)。申請配額是以每個 IP 每小時的申請次數為單位計算。

TemporaryQuota

暫時提高 / 降低配額

欄位
quota	int64 對應至 QuotaServer 設定中的「refill_token_count」欄位
start_time	Timestamp 這個配額何時生效
quota_duration	Duration 這項配額的有效時間長度

SignInConfig

與本機登入方法相關的設定。

欄位
email	Email 與透過電子郵件地址驗證使用者相關的設定選項。
phone_number	PhoneNumber 與透過電話號碼驗證使用者相關的設定選項。
anonymous	Anonymous 與匿名使用者驗證相關的設定選項。
allow_duplicate_emails	bool 是否允許多個帳戶使用相同的電子郵件地址。
hash_config	HashConfig 僅供輸出。雜湊設定資訊。

匿名

與匿名使用者驗證相關的設定選項。

欄位
enabled	bool 是否為專案啟用匿名使用者驗證功能。

電子郵件

與透過電子郵件地址驗證使用者相關的設定選項。

欄位
enabled	bool 專案是否已啟用電子郵件驗證功能。
password_required	bool 是否需要密碼才能進行電子郵件驗證。如果為 true，則必須提供電子郵件地址和密碼才能登入。如果為 false，使用者可以透過電子郵件/密碼或電子郵件連結登入。
hash_config	HashConfig 僅供輸出。雜湊設定資訊。

PhoneNumber

與透過電話號碼驗證使用者相關的設定選項。

欄位
enabled	bool 是否為專案啟用電話號碼驗證功能。
test_phone_numbers	map<string, string> 可用於電話驗證測試的 <測試電話號碼、假驗證碼> 對應表。

SpCertificate

服務供應商 (SP) 憑證資料的 proto，供 IdP 驗證由 SP 產生的 SAMLRequest。

欄位
x509_certificate	string 自行簽署的公開憑證。
expires_at	Timestamp 憑證到期例項的時間戳記。

用戶群

用戶群包含多租戶專案中用戶群的設定。

欄位
name	string 租用戶的資源名稱。例如：「projects/project1/tenants/tenant1」
display_name	string 用戶群的顯示名稱。
saml_configs[] (deprecated)	SamlConfig 這個項目已遭淘汰！ 要求的 SAML 設定。
idp_configs[] (deprecated)	IdpConfig 這個項目已遭淘汰！ 所要求的 IdP 設定。
allow_password_signup	bool 是否允許使用電子郵件/密碼註冊。
enable_email_link_signin	bool 是否啟用電子郵件連結註冊功能。
disable_auth	bool 是否已停用用戶群的驗證功能。停用租用戶下的使用者將無法登入。停用的租用戶管理員無法管理使用者。

UpdateConfigRequest

要求 UpdateConfig

欄位
config	Config 取代伺服器上資源的設定資源。 授權需要指定資源 config 的下列 IAM 權限： firebaseauth.configs.update
update_mask	FieldMask 更新遮罩會套用至資源。系統會忽略設定檔中未納入此更新遮罩的欄位。關於 FieldMask 的定義，請參閱 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateDefaultSupportedIdpConfigRequest

要求更新預設支援的 IdP 設定

欄位
default_supported_idp_config	DefaultSupportedIdpConfig 取代伺服器上資源的設定資源。 授權需要指定資源 defaultSupportedIdpConfig 的下列 IAM 權限： firebaseauth.configs.update
update_mask	FieldMask 更新遮罩會套用至資源。關於 FieldMask 的定義，請參閱 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateInboundSamlConfigRequest

要求 UpdateInboundSamlConfig

欄位
inbound_saml_config	InboundSamlConfig 取代伺服器上資源的設定資源。 授權需要指定資源 inboundSamlConfig 的下列 IAM 權限： firebaseauth.configs.update
update_mask	FieldMask 更新遮罩會套用至資源。空白的更新遮罩會導致沒有任何更新。關於 FieldMask 的定義，請參閱 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateOAuthIdpConfigRequest

要求更新 OAuthIdpConfig

欄位
oauth_idp_config	OAuthIdpConfig 取代伺服器上資源的設定資源。 授權需要指定資源 oauthIdpConfig 的下列 IAM 權限： firebaseauth.configs.update
update_mask	FieldMask 更新遮罩會套用至資源。空白的更新遮罩會導致沒有任何更新。關於 FieldMask 的定義，請參閱 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateTenantRequest

UpdateTenant 的要求訊息。

欄位
tenant	Tenant 這是必要旗標，要更新的租用戶。 授權需要指定資源 tenant 的下列 IAM 權限： identitytoolkit.tenants.update
update_mask	FieldMask 更新遮罩會套用至資源。關於 FieldMask 的定義，請參閱 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

VerifyDomainRequest

要求訊息，用於驗證要求的自訂網域是否有必要的 DNS 記錄。

欄位
resource	string 要驗證網域的資源名稱。這個方法目前接受專案 (例如「projects/my-awesome-project」) 或租用戶 (例如「projects/my-awesome-project/tenants/my-awesome-tenant」) 的驗證網域。 授權需要指定資源 resource 的下列 IAM 權限： firebaseauth.configs.update
domain	string 這項要求的目標網域。
action	DomainVerificationAction 在指定網域上嘗試執行的動作。

DomainVerificationAction

在指定網域上嘗試執行的動作。

列舉
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED	預設值。請勿使用。
VERIFY	驗證要求中的網域。
CANCEL	取消目前的驗證程序。
APPLY	在傳送電子郵件時套用自訂網域。

VerifyDomainResponse

針對 VerifyDomain 要求的回應。

欄位
verification_state	VerificationState 系統處理這項要求後，指定網域的最終狀態。
verification_error	string 如有需要，請說明為何無法啟用網域驗證功能。