Config

表示 Identity 工具包项目。

JSON 表示法 
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
字段
name

string

仅限输出。Config 资源的名称。示例：“projects/my-awesome-project/config”
signIn

object (SignInConfig)

与本地登录方法相关的配置。
notification

object (NotificationConfig)

与向用户发送通知相关的配置。
quota

object (QuotaConfig)

与配额相关的配置。
monitoring

object (MonitoringConfig)

与监控项目活动相关的配置。
multiTenant

object (MultiTenantConfig)

与多租户功能相关的配置。
authorizedDomains[]

string

已获授权进行 OAuth 重定向的网域列表
subtype

enum (Subtype)

仅限输出。此配置的子类型。
client

object (ClientConfig)

与应如何配置代表项目发出请求的客户端相关的选项。
mfa

object (MultiFactorAuthConfig)

此项目的多重身份验证配置，包括其是否处于启用状态以及可用于第二重身份验证的因素
blockingFunctions

object (BlockingFunctionsConfig)

与屏蔽函数相关的配置。
recaptchaConfig

object (RecaptchaConfig)

项目级 reCAPTCHA 配置。
smsRegionConfig

object (SmsRegionConfig)

配置启用短信验证码发送功能的区域。
autodeleteAnonymousUsers

boolean

是否会在 30 天后自动删除匿名用户。
passwordPolicyConfig

object (PasswordPolicyConfig)

项目级密码政策配置。
emailPrivacyConfig

object (EmailPrivacyConfig)

与电子邮件隐私和公开可见性相关的设置的配置。
defaultHostingSite

string

仅限输出。默认的 Firebase 托管站点名称

SignInConfig

与本地登录方法相关的配置。

JSON 表示法 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
字段
email

object (Email)

与通过电子邮件地址对用户进行身份验证相关的配置选项。
phoneNumber

object (PhoneNumber)

与通过电话号码对用户进行身份验证相关的配置选项。
anonymous

object (Anonymous)

与对匿名用户进行身份验证相关的配置选项。
allowDuplicateEmails

boolean

是否允许多个账号使用相同的电子邮件地址。
hashConfig

object (HashConfig)

仅限输出。哈希配置信息。

电子邮件

与通过电子邮件地址对用户进行身份验证相关的配置选项。

JSON 表示法 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
字段
enabled

boolean

是否为项目启用了电子邮件身份验证。
passwordRequired

boolean

电子邮件身份验证是否需要密码。如果为 true，则必须同时提供电子邮件地址和密码才能登录。如果为 false，用户可以通过电子邮件地址/密码或电子邮件链接登录。

PhoneNumber

与通过电话号码对用户进行身份验证相关的配置选项。

JSON 表示法 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
字段
enabled

boolean

是否为项目启用了电话号码身份验证。
testPhoneNumbers

map (key: string, value: string)

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

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

匿名

与对匿名用户进行身份验证相关的配置选项。

JSON 表示法 
{
  "enabled": boolean
}
字段
enabled

boolean

项目是否启用了匿名用户身份验证。

NotificationConfig

与向用户发送通知相关的配置。

JSON 表示法 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
字段
sendEmail

object (SendEmail)

电子邮件发送选项。
sendSms

object (SendSms)

短信发送选项。
defaultLocale

string

用于电子邮件和短信的默认语言区域，采用 IETF BCP 47 格式。

SendEmail

电子邮件发送选项。

JSON 表示法 
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
字段
method

enum (Method)

用于发送电子邮件的方法。
resetPasswordTemplate

object (EmailTemplate)

用于重置密码的电子邮件模板
verifyEmailTemplate

object (EmailTemplate)

用于验证电子邮件地址的电子邮件模板
changeEmailTemplate

object (EmailTemplate)

用于更改电子邮件的电子邮件模板
legacyResetPasswordTemplate

object (EmailTemplate)

为旧版 Firebase V1 应用添加了重置密码电子邮件模板。
callbackUri

string

电子邮件模板中的操作网址。
dnsInfo

object (DnsInfo)

自定义网域 DNS 验证信息。
revertSecondFactorAdditionTemplate

object (EmailTemplate)

用于撤消添加第二重身份验证的电子邮件的模板
联合字段 email_provider_config。用于发送电子邮件的电子邮件提供商配置 email_provider_config 只能是以下任一项：
smtp

object (Smtp)

使用自定义 SMTP 中继

方法

用于发送电子邮件的方法。

枚举
METHOD_UNSPECIFIED 未指定电子邮件方法。
DEFAULT 代表开发者发送电子邮件。
CUSTOM_SMTP 使用开发者提供的 SMTP 配置发送电子邮件。

SMTP

SMTP 中继的配置

JSON 表示法 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
字段
senderEmail

string

SMTP 中继的邮件发件人电子邮件地址
host

string

SMTP 中继主机
port

integer

SMTP 中继端口
username

string

SMTP 中继用户名
password

string

SMTP 中继密码
securityMode

enum (SecurityMode)

SMTP 安全模式。

SecurityMode

SMTP 安全模式。

枚举
SECURITY_MODE_UNSPECIFIED 默认值。请勿使用。
SSL SSL 模式
START_TLS START_TLS 模式

EmailTemplate

电子邮件模板。主题和正文字段可以包含以下占位符，系统会将其替换为适当的值：%LINK% - 用于兑换发送的 OOB 代码的链接。%EMAIL% - 电子邮件发送到的电子邮件地址。%NEW_EMAIL% - 为账号设置的新电子邮件地址（如果适用）。%APP_NAME% - Google Cloud 项目的显示名称。%DISPLAY_NAME% - 用户的显示名称。

JSON 表示法 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
字段
senderLocalPart

string

发件人地址的本地部分
subject

string

电子邮件主题
senderDisplayName

string

发件人显示名称
body

string

电子邮件正文
bodyFormat

enum (BodyFormat)

电子邮件正文格式
replyTo

string

回复地址
customized

boolean

仅限输出。电子邮件的正文或主题是否经过自定义。

BodyFormat

电子邮件正文格式

枚举
BODY_FORMAT_UNSPECIFIED 默认值。请勿使用。
PLAIN_TEXT 纯文本
HTML HTML

DnsInfo

自定义网域 DNS 验证信息。默认情况下，系统会使用 default_domain。您可以使用 VerifyCustomDomain 配置自定义网域。

JSON 表示法 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
字段
customDomain

string

仅限输出。已应用的经过验证的自定义网域。
useCustomDomain

boolean

是否使用自定义网域。
pendingCustomDomain

string

仅限输出。要验证的自定义网域。
customDomainState

enum (VerificationState)

仅限输出。自定义网域的当前验证状态。只有在域名验证成功后，系统才会使用自定义网域。
domainVerificationRequestTime

string (Timestamp format)

仅限输出。当前域名验证的初始请求的时间戳。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

SendSms

短信发送选项。

JSON 表示法 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
字段
useDeviceLocale

boolean

是否为短信使用 accept_language 标头。
smsTemplate

object (SmsTemplate)

仅限输出。发送短信时使用的模板。

SmsTemplate

发送短信时使用的模板。

JSON 表示法 
{
  "content": string
}
字段
content

string

仅限输出。短信的内容。可以包含以下占位符，这些占位符将替换为适当的值：%APP_NAME% - 对于 Android 或 iOS 应用，是应用的显示名称。对于 Web 应用，是托管应用的网域。%LOGIN_CODE% - 短信中发送的 OOB 代码。

QuotaConfig

与配额相关的配置。

JSON 表示法 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
字段
signUpQuotaConfig

object (TemporaryQuota)

注册端点的配额（如果被覆盖）。注册配额的衡量方式为：每个 IP 地址每小时可为每个项目完成的注册次数。

TemporaryQuota

临时配额增加 / 减少

JSON 表示法 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
字段
quota

string (int64 format)

对应于 QuotaServer 配置中的“refill_token_count”字段
startTime

string (Timestamp format)

此配额何时生效

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
quotaDuration

string (Duration format)

此配额的有效期

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。

MultiTenantConfig

与多租户功能相关的配置。

JSON 表示法 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
字段
allowTenants

boolean

此项目是否可以有租户。
defaultTenantLocation

string

应在其下创建租户项目的默认云父级组织或文件夹。父级资源名称应采用“/”格式，例如“folders/123”或“organizations/456”。如果未设置此值，系统会在代理项目所在的组织或文件夹下创建租户。

子类型

此配置的子类型。

枚举
SUBTYPE_UNSPECIFIED 默认值。请勿使用。
IDENTITY_PLATFORM Identity Platform 项目。
FIREBASE_AUTH 一个 Firebase Authentication 项目。

ClientConfig

与应如何配置代表项目发出请求的客户端相关的选项。

JSON 表示法 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
字段
apiKey

string

仅限输出。用于针对此项目发出请求的 API 密钥。
permissions

object (Permissions)

与限制用户对其账号的影响力相关的配置。
firebaseSubdomain

string

仅限输出。Firebase 子网域。

权限

与限制用户对其账号的影响力相关的配置。

JSON 表示法 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
字段
disabledUserSignup

boolean

如果为 true，最终用户将无法通过我们的任何 API 方法在关联的项目中注册新账号
disabledUserDeletion

boolean

如果为 true，最终用户将无法通过我们的任何 API 方法删除其在关联项目中的账号

BlockingFunctionsConfig

与阻塞函数相关的配置。

JSON 表示法 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
字段
triggers

map (key: string, value: object (Trigger))

触发器与事件类型的映射。键应为以下受支持的事件类型之一：“beforeCreate”“beforeSignIn”

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
forwardInboundCredentials

object (ForwardInboundCredentials)

要包含在发送到已注册的屏蔽函数的 JWT 载荷中的用户凭据。

触发器

带有 HTTP 触发器的同步 Cloud Functions 函数

JSON 表示法 
{
  "functionUri": string,
  "updateTime": string
}
字段
functionUri

string

Cloud Functions 函数的 HTTP URI 触发器。
updateTime

string (Timestamp format)

触发器的更改时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

ForwardInboundCredentials

指明要将哪些凭据传递给已注册的屏蔽函数。

JSON 表示法 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
字段
idToken

boolean

是否传递用户的 OIDC 身份提供方的 ID 令牌。
accessToken

boolean

是否传递用户的 OAuth 身份提供方的访问令牌。
refreshToken

boolean

是否传递用户的 OAuth 身份提供方的刷新令牌。