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

出力専用。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)

このプロジェクトの多要素認証の構成（有効かどうか、2 つ目の要素に使用できる要素など）
blockingFunctions

object (BlockingFunctionsConfig)

ブロッキング関数に関連する構成。
recaptchaConfig

object (RecaptchaConfig)

プロジェクト レベルの reCAPTCHA 構成。
smsRegionConfig

object (SmsRegionConfig)

SMS 確認コードの送信が有効なリージョンを設定します。
autodeleteAnonymousUsers

boolean

匿名ユーザーを 30 日後に自動削除するかどうか。
passwordPolicyConfig

object (PasswordPolicyConfig)

プロジェクト レベルのパスワード ポリシーの構成。
emailPrivacyConfig

object (EmailPrivacyConfig)

メールのプライバシーと公開設定に関連する設定の構成。
defaultHostingSite

string

出力専用。デフォルトの Firebase Hosting サイト名

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)

SMS 送信のオプション。
defaultLocale

string

メールと SMS に使用されるデフォルトのロケール（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

メール テンプレートのアクション URL。
dnsInfo

object (DnsInfo)

カスタム ドメインの DNS 確認に関する情報。
revertSecondFactorAdditionTemplate

object (EmailTemplate)

第 2 要素の追加メールを元に戻すためのメール テンプレート
共用体フィールド 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

SMS 送信のオプション。

JSON 表現 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
フィールド
useDeviceLocale

boolean

SMS に accept_language ヘッダーを使用するかどうか。
smsTemplate

object (SmsTemplate)

出力専用。SMS の送信時に使用するテンプレート。

SmsTemplate

SMS の送信時に使用するテンプレート。

JSON 表現 
{
  "content": string
}
フィールド
content

string

出力専用。SMS の内容。次のプレースホルダを含めることができます。これらのプレースホルダは、適切な値に置き換えられます。%APP_NAME% - Android アプリまたは iOS アプリの場合、アプリの表示名。ウェブアプリの場合は、アプリケーションをホストしているドメイン。%LOGIN_CODE% - SMS で送信される OOB コード。

QuotaConfig

割り当てに関連する構成。

JSON 表現 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
フィールド
signUpQuotaConfig

object (TemporaryQuota)

登録エンドポイントの割り当て（上書きされている場合）。登録クォータは、プロジェクト、IP、1 時間あたりの登録数で測定されます。

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 で終わる小数 9 桁までの秒単位の期間。例: "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 プロバイダの ID トークンを渡すかどうか。
accessToken

boolean

ユーザーの OAuth ID プロバイダのアクセス トークンを渡すかどうか。
refreshToken

boolean

ユーザーの OAuth ID プロバイダの更新トークンを渡すかどうか。