Package google.cloud.identitytoolkit.admin.v2

索引

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。
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。
GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

取得資源的存取權控管政策。如果資源不存在，系統會傳回錯誤。如果資源存在，但未設定政策，系統會傳回空的政策。呼叫端必須具備資源的 Google IAM 權限。

授權範圍

需要下列其中一種 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。
InitializeIdentityPlatform

rpc InitializeIdentityPlatform(InitializeIdentityPlatformRequest) returns (InitializeIdentityPlatformResponse)

為 Cloud 專案初始化 Identity Platform。Identity Platform 是端對端驗證系統，可讓第三方使用者存取您的應用程式和服務。包括行動/網頁應用程式、遊戲、API 等。

這是 EnableIdentityPlatform 的公開變化版本，僅適用於啟用帳單功能的專案。

授權範圍

需要下列 OAuth 範圍：

  • 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。
SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

設定資源的存取權控管政策。如果政策已存在，系統會將其取代。呼叫端必須具備資源的 Google IAM 權限。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱 Authentication Overview。
TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

傳回呼叫者對資源的權限。如果資源不存在，系統會傳回錯誤。來電者不需要具備 Google IAM 權限即可提出這項要求。

授權範圍

需要下列其中一種 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」
forward_inbound_credentials

ForwardInboundCredentials

要納入 JWT 酬載的使用者憑證，該酬載會傳送至已註冊的阻斷函式。

觸發條件

使用 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 方法刪除相關專案中的帳戶

ClientPermissionConfig

與用戶端如何代表租用戶提出要求的設定相關的選項。

欄位
permissions

ClientPermissions

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

ClientPermissions

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

欄位
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

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

MultiTenantConfig

與多用戶群功能相關的設定。
authorized_domains[]

string

已授權重新導向 OAuth 的網域清單
subtype

Subtype

僅供輸出。此設定的子類型。
client

ClientConfig

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

MultiFactorAuthConfig

這個專案的多重驗證設定，包括是否啟用多重驗證，以及可用於第二因素的驗證方式
blocking_functions

BlockingFunctionsConfig

與封鎖函式相關的設定。
recaptcha_config

RecaptchaConfig

專案層級的 reCAPTCHA 設定。
sms_region_config

SmsRegionConfig

設定哪些區域可傳送簡訊驗證碼。
autodelete_anonymous_users

bool

匿名使用者是否會在 30 天後自動刪除。
password_policy_config

PasswordPolicyConfig

專案層級密碼政策設定。
email_privacy_config

EmailPrivacyConfig

與電子郵件隱私權和公開顯示相關的設定。
default_hosting_site

string

僅供輸出。預設 Firebase 託管網站名稱

子類型

此設定的子類型。

列舉
SUBTYPE_UNSPECIFIED 預設值。請勿使用。
IDENTITY_PLATFORM Identity Platform 專案。
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 用戶端密鑰。
聯集欄位 idp_specific_config。特定登入類型的 IDP 設定。idp_specific_config 只能是下列其中一項：
apple_sign_in_config

AppleSignInConfig

適用於 Apple 專案的其他設定。

AppleSignInConfig

SignInWithApple 的其他設定。

欄位
code_flow_config

CodeFlowConfig

Apple 代碼流程的其他設定。
bundle_ids[]

string

這個專案可用的 Bundle ID 清單

CodeFlowConfig

Apple 代碼流程的其他設定。

欄位
team_id

string

Apple Developer Team ID。
key_id

string

私密金鑰的金鑰 ID。
private_key

string

用於簽署用戶端密鑰 JWT 的私密金鑰。

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

EmailPrivacyConfig

與電子郵件隱私權和公開顯示相關的設定。這項設定可防範電子郵件列舉，但可能會影響使用者體驗。

欄位
enable_improved_email_privacy

bool

將專案遷移至可改善電子郵件隱私權的狀態。舉例來說，某些錯誤代碼較為通用，可避免洩漏帳戶是否存在的資訊。此外，這項設定會停用某些功能，以避免使用者列舉。啟用這個切換鈕會停用 fetchSignInMethodsForEmail 功能，並將使用者的電子郵件地址變更為未驗證的電子郵件地址。建議您停止依賴這項功能，並啟用此切換鈕來提升使用者隱私。

ForwardInboundCredentials

指出要將哪些憑證傳遞至已註冊的封鎖函式。

欄位
id_token

bool

是否要傳遞使用者的 OIDC 身分識別提供者 ID 權杖。
access_token

bool

是否要傳遞使用者的 OAuth 身分識別提供者存取權杖。
refresh_token

bool

指出是否要傳遞使用者的 OAuth 身分識別資訊提供者的更新權杖。

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 的憑證資料，用於驗證 IDP 核發的 SAMLResponse 中的簽名。

欄位
x509_certificate

string

x509 憑證

InboundSamlConfig

專案以信賴方身分運作時，一組 SAML RP-IDP 設定。

欄位
name

string

InboundSamlConfig 資源的名稱，例如：`projects/my-awesome-project/inboundSamlConfigs/my-config-id`。系統會在建立要求時忽略此欄。
idp_config

IdpConfig

專案做為依賴方時的 SAML IdP (識別資訊提供者) 設定。
sp_config

SpConfig

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

string

開發人員設定的設定顯示名稱。
enabled

bool

如果允許使用者透過提供者登入，則值為「是」。

IdpConfig

專案做為依賴方時的 SAML IdP (識別資訊提供者) 設定。

欄位
idp_entity_id

string

所有 SAML 實體的專屬 ID。
sso_url

string

要傳送驗證要求的網址。
idp_certificates[]

IdpCertificate

IdP 的公開金鑰，用於驗證斷言中的簽章。
sign_request

bool

指出是否應為傳出 SAMLRequest 簽署。

SpConfig

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

欄位
sp_entity_id

string

所有 SAML 實體的專屬 ID。
callback_uri

string

用於處理來自 IDP 的回應的回呼 URI。
sp_certificates[]

SpCertificate

僅供輸出。伺服器產生的公開憑證，用於驗證 SP 啟動流程中 SAMLRequest 中的簽名。

繼承

租用戶將從專案層級繼承的設定。

欄位
email_sending_config

bool

是否允許租用戶繼承自訂網域、電子郵件範本和自訂 SMTP 設定。如果為 true，租用戶傳送的電子郵件會遵循專案層級的電子郵件傳送設定。如果為 false (預設值)，電子郵件會使用預設設定，且不會進行自訂。

InitializeIdentityPlatformRequest

要求 InitializeIdentityPlatform。

欄位
project

string

開發人員要為其啟用 Identity Platform 的目標專案資源名稱。

授權需要指定資源 project 的下列 IAM 權限：

  • firebaseauth.configs.create

InitializeIdentityPlatformResponse

這個類型沒有任何欄位。

InitializeIdentityPlatform 的回應。目前為空白。

ListDefaultSupportedIdpConfigsRequest

要求 ListDefaultSupportedIdpConfigs

欄位
parent

string

父項資源名稱，例如「projects/my-awesome-project」。

授權需要指定資源 parent 的下列 IAM 權限：

  • firebaseauth.configs.get
page_size

int32

傳回的項目數量上限。
page_token

string

先前的 List 要求 (如果有的話) 傳回的 next_page_token 值。

ListDefaultSupportedIdpConfigsResponse

針對 DefaultSupportedIdpConfigs 的回應

欄位
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

用來取得下一頁結果的符記。

MfaState

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

列舉
MFA_STATE_UNSPECIFIED 非法狀態，不應使用。
DISABLED 這個專案無法使用多重驗證。
ENABLED 這個專案可使用多重驗證。
MANDATORY 這個專案需要啟用多重驗證。這個專案的使用者必須使用第二層驗證機制進行驗證。

MobileLinksConfig

設定行動連結。

欄位
domain

Domain

在應用程式網域中開啟應用程式連結和通用連結的程式碼。

網域

應用程式網域中可能的開放程式碼，可用於應用程式連結和通用連結。

列舉
DOMAIN_UNSPECIFIED 預設值。預設網域是 FDL 淘汰前 Firebase Dynamic Link 網域，以及 FDL 淘汰後的代管網域。
HOSTING_DOMAIN 使用代管網域做為應用程式連結網域。

MonitoringConfig

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

欄位
request_logging

RequestLogging

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

RequestLogging

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

欄位
enabled

bool

是否為此專案啟用記錄功能。

MultiFactorAuthConfig

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

欄位
state

State

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

Provider

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

ProviderConfig

這個專案可用的第二種驗證因素清單，以及相關設定。這個欄位不支援使用「enabled_providers」欄位的電話式 MFA。

供應商

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

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

狀態

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

列舉
STATE_UNSPECIFIED 非法狀態，不應使用。
DISABLED 這個專案無法使用多重驗證
ENABLED 這個專案可使用多重驗證
MANDATORY 這個專案需要啟用多重驗證。這個專案的使用者必須使用第二層驗證機制進行驗證。

MultiTenantConfig

與多用戶群功能相關的設定。

欄位
allow_tenants

bool

此專案是否可有租戶。
default_tenant_location

string

要建立租用戶專案的預設雲端上層機構或資料夾。父項資源名稱的格式應為「/」，例如「folders/123」或「organizations/456」。如果未設定值，系統會在與代理程式專案相同的機構或資料夾下建立租用戶。

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 驗證資訊。
revert_second_factor_addition_template

EmailTemplate

撤銷新增第二層驗證電子郵件的電子郵件範本
聯集欄位 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 回應類型。

PasswordPolicyConfig

專案的密碼政策設定。

欄位
password_policy_enforcement_state

PasswordPolicyEnforcementState

密碼政策要使用的強制執行模式。
password_policy_versions[]

PasswordPolicyVersion

長度必須為 1。包含密碼政策的強度屬性。
force_upgrade_on_signin

bool

使用者必須使用符合密碼政策的密碼才能登入。
last_update_time

Timestamp

僅供輸出。專案上次更新密碼政策的時間。

PasswordPolicyEnforcementState

密碼政策的強制執行狀態

列舉
PASSWORD_POLICY_ENFORCEMENT_STATE_UNSPECIFIED 非法狀態，不應使用。
OFF 專案不會使用密碼政策。
ENFORCE 系統會拒絕不符合密碼政策的密碼，並擲回錯誤。

PasswordPolicyVersion

專案密碼政策的強度屬性。

欄位
custom_strength_options

CustomStrengthOptions

密碼政策強制執行的自訂強度選項。
schema_version

int32

僅供輸出。密碼政策的結構定義版本號碼

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

密碼必須包含非英數字元。

ProviderConfig

ProviderConfig 會說明支援的 MFA 供應工具和相關設定。

欄位
state

MfaState

說明多重驗證類型的狀態。

聯集欄位 mfa_provider_config。

mfa_provider_config 只能是下列其中一項：
totp_provider_config

TotpMfaProviderConfig

這項專案的 TOTP MFA 供應器設定。

QuotaConfig

與配額相關的設定。

欄位
sign_up_quota_config

TemporaryQuota

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

TemporaryQuota

暫時提高 / 降低配額

欄位
quota

int64

對應至 QuotaServer 設定中的「refill_token_count」欄位
start_time

Timestamp

這個配額何時生效
quota_duration

Duration

這項配額的有效時間長度

RecaptchaConfig

reCAPTCHA Enterprise 整合設定。

欄位
managed_rules[]

RecaptchaManagedRule

根據 reCAPTCHA 分數採取驗證動作的受管理規則。規則會在特定租用戶專案的各個供應器之間共用。
recaptcha_keys[]

RecaptchaKey

reCAPTCHA 金鑰。
toll_fraud_managed_rules[]

RecaptchaTollFraudManagedRule

根據 reCAPTCHA 費用詐欺風險分數，為驗證動作設定受管理的規則。只有在 phone_enforcement_state 為 AUDIT 或 ENFORCE，且 use_sms_toll_fraud_protection 為 true 時，付費詐欺管理規則才會生效。
email_password_enforcement_state

RecaptchaProviderEnforcementState

電子郵件/密碼提供者的 reCAPTCHA 設定，包含強制執行狀態。電子郵件/密碼提供者包含 reCAPTCHA 保護的所有電子郵件相關使用者流程。
use_account_defender

bool

是否要使用帳戶防護工具進行 reCAPTCHA 評估。預設值為 false。
phone_enforcement_state

RecaptchaProviderEnforcementState

電話號碼提供者的 reCAPTCHA 設定，包含強制執行狀態。電話服務供應商包含所有 reCAPTCHA 保護的簡訊相關使用者流程。
use_sms_bot_score

bool

是否要為 reCAPTCHA 電話服務供應商使用 rCE 機器人分數。只有在 phone_enforcement_state 為 AUDIT 或 ENFORCE 時，才能設為 true。
use_sms_toll_fraud_protection

bool

是否要為 reCAPTCHA 電話供應商使用 rCE 簡訊費用詐欺防護風險分數。只有在 phone_enforcement_state 為 AUDIT 或 ENFORCE 時，才能設為 true。

RecaptchaProviderEnforcementState

reCAPTCHA 防護機制的強制執行狀態。

列舉
RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED 未設定強制執行狀態。
OFF 未強制執行。
AUDIT 建立 reCAPTCHA 評估，但不會使用結果強制執行。
ENFORCE 建立 reCAPTCHA 評估，並使用結果強制執行。

RecaptchaKey

reCAPTCHA 金鑰設定。reCAPTCHA Enterprise 會為不同的用戶端平台提供不同的金鑰。

欄位
key

string

reCAPTCHA Enterprise 金鑰資源名稱，例如「projects/{project}/keys/{key}」
type

RecaptchaKeyClientType

用戶端的平台類型。

RecaptchaKeyClientType

reCAPTCHA Enterprise 金鑰支援的不同用戶端。

列舉
CLIENT_TYPE_UNSPECIFIED 未指定用戶端類型。
WEB 用戶端類型為網頁。
IOS 用戶端類型為 iOS。
ANDROID 用戶端類型為 Android。

RecaptchaManagedRule

reCAPTCHA 受管理規則的設定。模擬單一間隔 [start_score, end_score]。start_score 是隱含的。它是 end_score 最接近的較小值 (如果有)，或 0。匯總區間的範圍為 [0, 1]，且不重疊。

欄位
end_score

float

動作得分範圍的結束得分 (含此分數)。必須是介於 0.0 和 1.0 之間的值，且有 11 個不連續值，例如 0、0.1、0.2、0.3、... 0.9、1.0。分數為 0.0 代表風險最高的要求 (可能是機器人)，分數為 1.0 則代表風險最低的要求 (可能是人為)。請參閱 https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment。
action

RecaptchaAction

如果要求的 reCAPTCHA 分數介於 [start_score, end_score] 之間，系統會採取這項動作。

RecaptchaAction

reCAPTCHA 保護要求的動作。

列舉
RECAPTCHA_ACTION_UNSPECIFIED 未指定 reCAPTCHA 動作。
BLOCK reCAPTCHA 保護的要求會遭到封鎖。

RecaptchaTollFraudManagedRule

reCAPTCHA 收費詐欺評估管理規則的設定。模擬單一間隔 [start_score, end_score]。end_score 是隱含值。它是 end_score 最接近的較小值 (如果有)，或 0。匯總區間的範圍為 [0, 1]，且不重疊。

欄位
start_score

float

動作的起始分數 (含此分數)。必須是介於 0.0 和 1.0 之間的值，且有 11 個不連續值，例如 0、0.1、0.2、0.3、... 0.9、1.0。分數為 0.0 的請求最安全 (很可能是合法請求)，分數為 1.0 的請求風險最高 (很可能是費用詐欺)。請參閱 https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms。
action

RecaptchaAction

如果要求的 reCAPTCHA 分數介於 [start_score, end_score] 之間，系統會採取這項動作。

RecaptchaAction

預設為 RECAPTCHA_ACTION_UNSPECIFIED

列舉
RECAPTCHA_ACTION_UNSPECIFIED 未指定 reCAPTCHA 動作。
BLOCK reCAPTCHA 保護的要求會遭到封鎖。

SignInConfig

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

欄位
email

Email

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

PhoneNumber

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

Anonymous

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

bool

是否允許多個帳戶使用相同的電子郵件地址。
hash_config

HashConfig

僅供輸出。雜湊設定資訊。

匿名

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

欄位
enabled

bool

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

電子郵件

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

欄位
enabled

bool

專案是否已啟用電子郵件驗證功能。
password_required

bool

是否需要密碼才能進行電子郵件驗證。如果為 true，則必須提供電子郵件地址和密碼才能登入。如果為 false，使用者可以透過電子郵件/密碼或電子郵件連結登入。

PhoneNumber

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

欄位
enabled

bool

是否為專案啟用電話號碼驗證功能。
test_phone_numbers

map<string, string>

可用於電話驗證測試的 <測試電話號碼、假驗證碼> 對應表。

SmsRegionConfig

設定使用者可為專案或租用戶傳送驗證簡訊的區域。這取決於目的地電話號碼的撥號碼。

欄位
聯集欄位 sms_region_policy。這項政策可讓使用者傳送驗證簡訊。您可以預設允許所有地區，也可以只允許明確的許可清單中的地區。sms_region_policy 只能是下列其中一項：
allow_by_default

AllowByDefault

預設允許傳送 SMS 至所有區域的政策，並將不允許的區域加入禁止清單。
allowlist_only

AllowlistOnly

政策只允許明確加入許可清單的區域。

AllowByDefault

定義預設允許所有區域的政策，並將不允許的區域加入不允許清單。

欄位
disallowed_regions[]

string

根據 https://cldr.unicode.org/ 定義，禁止使用兩個字母的萬國碼區域代碼。這些區域代碼的完整清單如下：https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json

AllowlistOnly

定義只允許特定區域的政策，並明確將這些區域加入許可清單。

欄位
allowed_regions[]

string

根據 https://cldr.unicode.org/ 定義，允許使用兩個字母的 Unicode 區域代碼。這些區域代碼的完整清單如下：https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json

SpCertificate

IdP 用來驗證服務供應商 (SP) 產生的 SAMLRequest 的 SP 憑證資料。

欄位
x509_certificate

string

自行簽署的公開憑證。
expires_at

Timestamp

憑證到期例項的時間戳記。

用戶群

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

欄位
name

string

僅供輸出。租用戶的資源名稱。例如：projects/{project-id}/tenants/{tenant-id}
display_name

string

用戶群的顯示名稱。
allow_password_signup

bool

是否允許使用電子郵件/密碼驗證使用者。
disable_auth

bool

是否已為租用戶停用驗證機制。如果設為「是」，則停用的租用戶下的使用者將無法登入。停用的租用戶管理員無法管理使用者。
hash_config

HashConfig

僅供輸出。用於在 Pantheon 上顯示的租用戶雜湊設定資訊。這項資訊只能在 Pantheon 上顯示，以免機密資訊意外外洩。僅在 GetTenant 回應中傳回，用於限制讀取這項資訊。如要傳回這個欄位，代理程式專案必須具備 firebaseauth.configs.getHashConfig 權限。
enable_anonymous_user

bool

是否啟用匿名使用者驗證功能。
mfa_config

MultiFactorAuthConfig

多重身份驗證選項的租用戶層級設定。
test_phone_numbers

map<string, string>

可用於 MFA 的 <測試電話號碼、假驗證碼> 對應項目。電話號碼應採用 E.164 格式 (https://www.itu.int/rec/T-REC-E.164/)，且最多可新增 10 組 (超過上限時會擲回錯誤)。
inheritance

Inheritance

指定租用戶可繼承的設定。
recaptcha_config

RecaptchaConfig

租戶層級的 reCAPTCHA 設定。
sms_region_config

SmsRegionConfig

設定哪些區域可傳送簡訊驗證碼。
autodelete_anonymous_users

bool

匿名使用者是否會在 30 天後自動刪除。
monitoring

MonitoringConfig

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

PasswordPolicyConfig

用戶群層級密碼政策設定
email_privacy_config

EmailPrivacyConfig

與電子郵件隱私權和公開顯示相關的設定。
client

ClientPermissionConfig

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

TotpMfaProviderConfig

TotpMFAProviderConfig 代表以 TOTP 為基礎的 MFA 供應器。

欄位
adjacent_intervals

int32

允許用於驗證的鄰近間隔數量，以避免時鐘偏差。

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

如有需要，請說明為何無法啟用網域驗證功能。