Package google.cloud.identitytoolkit.v2beta1

索引

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 for Customers and Partners（以下简称 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)

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

授权范围

需要以下 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 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 方法删除其在关联项目中的账号

配置

表示 Identity 工具包项目。

字段
name

string

仅限输出。Config 资源的名称。示例：“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 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 客户端密钥。
display_on_cloud_console

bool

仅限输出。如果 IdP 处于停用状态，是否在 Pantheon 上显示 IdP 配置。

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

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

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

IdpConfig

在项目充当信赖方时用于存储 SAML IdP（身份提供方）配置的 proto。

字段
idp_entity_id

string

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

string

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

IdpCertificate

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

bool

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

SpConfig

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

字段
sp_entity_id

string

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

返回的结果数上限（上限为 1, 000）。如果未指定，默认值为 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

仅限输出。短信的内容。可以包含以下占位符，这些占位符将替换为适当的值：%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 响应类型。

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>

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

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

是否允许使用电子邮件地址/密码进行注册。
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

对 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

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