Config

代表 Identity Toolkit 專案。

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

僅供輸出。設定資源的名稱。例如：「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)

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

包含 "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

僅供輸出。SMS 內容。可包含下列預留位置，系統會以適當的值取代這些預留位置：%APP_NAME% - 針對 Android 或 iOS 應用程式，這是應用程式的顯示名稱。如果是網頁應用程式，則是代管應用程式的網域。%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)

這項配額的有效時間長度

以秒為單位的時間長度，最多可有 9 個小數位數，結尾為「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 驗證專案。

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 函式

JSON 表示法 
{
  "functionUri": string,
  "updateTime": string
}
欄位
functionUri

string

Cloud 函式的 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 身分識別資訊提供者的更新權杖。