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 是一个端到端身份验证系统，可供第三方用户访问您的应用和服务。这些产品和服务可能包括移动/Web 应用、游戏、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)

列出给定代理项目下的租户。需要对代理项目拥有读取权限。

授权范围

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

字段
function_uri

string

Cloud Functions 函数的 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 工具包项目。

字段
name

string

仅限输出。Config 资源的名称。示例：“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 Authentication 项目。

CreateDefaultSupportedIdpConfigRequest

对 CreateDefaultSupportedIdpConfig 的请求

字段
parent

string

要创建配置的父资源名称，例如：projects/my-awesome-project

必须对指定的资源 parent 具有以下 IAM 权限才能进行授权：

  • firebaseauth.configs.update
idp_id

string

要为其创建配置的 IdP 的 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 the of Idp
description

string

IDP 说明

DefaultSupportedIdpConfig

用于通过一组标准的 Identity Toolkit 受信任 IDP 进行身份验证的配置选项。

字段
name

string

DefaultSupportedIdpConfig 资源的名称，例如：“projects/my-awesome-project/defaultSupportedIdpConfigs/google.com”
enabled

bool

如果允许用户使用提供方进行登录，则为 true。
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

此项目可用的软件包 ID 列表

CodeFlowConfig

针对 Apple 的代码流程的其他配置。

字段
team_id

string

Apple 开发者团队 ID。
key_id

string

私钥的密钥 ID。
private_key

string

用于为客户端密钥 JWT 签名的私钥。

DeleteDefaultSupportedIdpConfigRequest

对 DeleteDefaultSupportedIdpConfig 的请求

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

对 DeleteOAuthIdpConfig 的请求

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

如果允许用户使用提供方进行登录，则为 true。

IdpConfig

当项目充当信赖方时，SAML IdP（身份提供方）配置。

字段
idp_entity_id

string

所有 SAML 实体的唯一标识符。
sso_url

string

用于发送身份验证请求的网址。
idp_certificates[]

IdpCertificate

用于验证断言中签名的 IDP 公钥。
sign_request

bool

指明是否应对出站 SAMLRequest 进行签名。

SpConfig

当项目充当依赖方以接收和接受 SAML 身份提供方发出的身份验证断言时，SAML SP（服务提供商）配置。

字段
sp_entity_id

string

所有 SAML 实体的唯一标识符。
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

返回的结果数上限（上限为 1, 000）。如果未指定，默认值为 20。

ListTenantsResponse

ListTenants 的响应消息。

字段
tenants[]

Tenant

给定代理项目下的租户列表。
next_page_token

string

用于获取下一页结果的令牌。

MfaState

是否为此项目启用了多重身份验证。

枚举
MFA_STATE_UNSPECIFIED 非法状态，不应使用。
DISABLED 无法对此项目使用多重身份验证。
ENABLED 此项目可以使用多重身份验证。
MANDATORY 此项目需要进行多重身份验证。此项目中的用户必须使用第二重身份验证方法进行身份验证。

MobileLinksConfig

配置移动链接。

字段
domain

Domain

在应用网域中打开代码，以供应用链接和通用链接使用。

网域

应用网域中可能的开放代码，用于应用链接和通用链接。

枚举
DOMAIN_UNSPECIFIED 默认值。默认网域是 FDL 弃用前的 Firebase Dynamic Links 网域，是 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”字段。

提供商

此项目可用的第二重身份验证方法的列表。

枚举
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

仅限输出。短信的内容。可以包含以下占位符，这些占位符将替换为适当的值：%APP_NAME% - 对于 Android 或 iOS 应用，是应用的显示名称。对于 Web 应用，是托管应用的网域。%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，是颁发者标识符。
display_name

string

开发者设置的配置显示名称。
enabled

bool

如果允许用户使用提供方进行登录，则为 true。
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，则 ID 令牌会从 IdP 的授权端点返回。
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 客户端类型为 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>

可用于电话身份验证测试的 <test phone number, fake code> 映射。

SmsRegionConfig

配置允许用户为项目或租户发送验证短信的区域。此字段基于目标电话号码的拨号代码。

字段
联合字段 sms_region_policy。用于指定允许用户发送验证短信的位置的政策。这可以是默认允许所有地区，也可以是仅通过明确的许可名单允许地区。sms_region_policy 只能是下列其中一项：
allow_by_default

AllowByDefault

默认允许向所有区域发送短信，并将禁止的区域添加到禁止名单中的政策。
allowlist_only

AllowlistOnly

仅通过将区域明确添加到许可名单来允许相应区域的政策。

AllowByDefault

定义一项政策，默认允许所有区域，并将禁止的区域添加到禁止列表。

字段
disallowed_regions[]

string

要禁止使用的两个字母 Unicode 地区代码（如 https://cldr.unicode.org/ 中所定义）。如需查看这些地区代码的完整列表，请访问：https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json

AllowlistOnly

定义仅通过将某些区域明确添加到许可名单来允许这些区域的政策。

字段
allowed_regions[]

string

允许的双字母 Unicode 地区代码（如 https://cldr.unicode.org/ 中所定义）。如需查看这些地区代码的完整列表，请访问：https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json

SpCertificate

SP 的证书数据，供 IDP 验证 SP 生成的 SAMLRequest。

字段
x509_certificate

string

自签名公共证书。
expires_at

Timestamp

证书到期实例的时间戳。

租户

租户包含多租户项目中的租户配置。

字段
name

string

仅限输出。租户的资源名称。例如："projects/{project-id}/tenants/{tenant-id}"
display_name

string

租户的显示名称。
allow_password_signup

bool

是否允许使用电子邮件地址/密码进行用户身份验证。
disable_auth

bool

是否为租户停用了身份验证。如果为 true，则停用租户下的用户将无法登录。停用的租户的管理员无法管理其用户。
hash_config

HashConfig

仅限输出。租户的哈希配置信息，用于在 Pantheon 上显示。此信息只能在 Pantheon 上显示，以免敏感信息意外泄露。仅在 GetTenant 响应中返回，以限制读取此信息。需要对代理项目拥有 firebaseauth.configs.getHashConfig 权限才能返回此字段。
enable_anonymous_user

bool

是否启用匿名用户身份验证。
mfa_config

MultiFactorAuthConfig

多重身份验证选项的租户级配置。
test_phone_numbers

map<string, string>

可用于多重身份验证的 <测试手机号码、虚假代码> 对的映射。电话号码应采用 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

对 UpdateDefaultSupportedIdpConfig 的请求

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

对 UpdateOAuthIdpConfig 的请求

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

说明域名无法验证的原因（如果适用）。