Config

Merepresentasikan project Identity Toolkit.

Representasi 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
}
Kolom
name

string

Hanya output. Nama resource Config. Contoh: "projects/my-awesome-project/config"
signIn

object (SignInConfig)

Konfigurasi yang terkait dengan metode login lokal.
notification

object (NotificationConfig)

Konfigurasi yang terkait dengan pengiriman notifikasi kepada pengguna.
quota

object (QuotaConfig)

Konfigurasi yang terkait dengan kuota.
monitoring

object (MonitoringConfig)

Konfigurasi yang terkait dengan pemantauan aktivitas project.
multiTenant

object (MultiTenantConfig)

Konfigurasi yang terkait dengan fungsi multi-tenant.
authorizedDomains[]

string

Daftar domain yang diotorisasi untuk pengalihan OAuth
subtype

enum (Subtype)

Hanya output. Subjenis konfigurasi ini.
client

object (ClientConfig)

Opsi terkait cara klien membuat permintaan atas nama project harus dikonfigurasi.
mfa

object (MultiFactorAuthConfig)

Konfigurasi untuk autentikasi multi-faktor project ini, termasuk apakah autentikasi aktif dan faktor apa yang dapat digunakan untuk faktor kedua
blockingFunctions

object (BlockingFunctionsConfig)

Konfigurasi yang terkait dengan fungsi pemblokiran.
recaptchaConfig

object (RecaptchaConfig)

Konfigurasi reCAPTCHA tingkat project.
smsRegionConfig

object (SmsRegionConfig)

Mengonfigurasi wilayah yang diaktifkan untuk pengiriman kode verifikasi SMS.
autodeleteAnonymousUsers

boolean

Apakah pengguna anonim akan otomatis dihapus setelah periode 30 hari.
passwordPolicyConfig

object (PasswordPolicyConfig)

Konfigurasi kebijakan sandi level project.
emailPrivacyConfig

object (EmailPrivacyConfig)

Konfigurasi untuk setelan yang terkait dengan privasi email dan visibilitas publik.
defaultHostingSite

string

Hanya output. Nama situs hosting Firebase default

SignInConfig

Konfigurasi yang terkait dengan metode login lokal.

Representasi JSON 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Kolom
email

object (Email)

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan alamat emailnya.
phoneNumber

object (PhoneNumber)

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan nomor telepon mereka.
anonymous

object (Anonymous)

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna anonim.
allowDuplicateEmails

boolean

Apakah akan mengizinkan lebih dari satu akun memiliki email yang sama.
hashConfig

object (HashConfig)

Hanya output. Informasi konfigurasi hash.

Email

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan alamat emailnya.

Representasi JSON 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Kolom
enabled

boolean

Apakah autentikasi email diaktifkan untuk project atau tidak.
passwordRequired

boolean

Apakah sandi diperlukan untuk autentikasi email atau tidak. Jika true, email dan sandi harus diberikan untuk login. Jika salah, pengguna dapat login melalui email/sandi atau link email.

PhoneNumber

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan nomor telepon mereka.

Representasi JSON 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Kolom
enabled

boolean

Apakah autentikasi nomor telepon diaktifkan untuk project atau tidak.
testPhoneNumbers

map (key: string, value: string)

Peta <nomor telepon pengujian, kode palsu> yang dapat digunakan untuk pengujian autentikasi telepon.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anonim

Opsi konfigurasi yang terkait dengan mengautentikasi pengguna anonim.

Representasi JSON 
{
  "enabled": boolean
}
Kolom
enabled

boolean

Apakah autentikasi pengguna anonim diaktifkan untuk project atau tidak.

NotificationConfig

Konfigurasi yang terkait dengan pengiriman notifikasi kepada pengguna.

Representasi JSON 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Kolom
sendEmail

object (SendEmail)

Opsi untuk pengiriman email.
sendSms

object (SendSms)

Opsi untuk pengiriman SMS.
defaultLocale

string

Lokalitas default yang digunakan untuk email dan SMS dalam format IETF BCP 47.

SendEmail

Opsi untuk pengiriman email.

Representasi 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.
}
Kolom
method

enum (Method)

Metode yang digunakan untuk mengirim email.
resetPasswordTemplate

object (EmailTemplate)

Template email untuk reset sandi
verifyEmailTemplate

object (EmailTemplate)

Template email untuk memverifikasi email
changeEmailTemplate

object (EmailTemplate)

Template email untuk email perubahan
legacyResetPasswordTemplate

object (EmailTemplate)

Template email reset sandi untuk aplikasi Firebase V1 lama.
callbackUri

string

URL tindakan dalam template email.
dnsInfo

object (DnsInfo)

Informasi verifikasi DNS domain kustom.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Template email untuk mengembalikan email penambahan faktor kedua
Kolom union email_provider_config. Konfigurasi penyedia email yang digunakan untuk mengirim email email_provider_config hanya dapat berupa salah satu dari hal berikut:
smtp

object (Smtp)

Menggunakan relai SMTP kustom

Metode

Metode yang digunakan untuk mengirim email.

Enum
METHOD_UNSPECIFIED Metode email tidak ditentukan.
DEFAULT Mengirim email atas nama developer.
CUSTOM_SMTP Mengirim email menggunakan konfigurasi SMTP yang disediakan oleh developer.

Smtp

Konfigurasi untuk relai SMTP

Representasi JSON 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Kolom
senderEmail

string

Email pengirim untuk relai SMTP
host

string

Host relai SMTP
port

integer

Port relai SMTP
username

string

Nama pengguna relai SMTP
password

string

Sandi relai SMTP
securityMode

enum (SecurityMode)

Mode keamanan SMTP.

SecurityMode

Mode keamanan SMTP.

Enum
SECURITY_MODE_UNSPECIFIED Nilai default. Jangan gunakan.
SSL Mode SSL
START_TLS Mode START_TLS

EmailTemplate

Template email. Kolom subjek dan isi dapat berisi placeholder berikut yang akan diganti dengan nilai yang sesuai: %LINK% - Link yang akan digunakan untuk menukarkan kode OOB yang dikirim. %EMAIL% - Email tujuan pengiriman email. %NEW_EMAIL% - Email baru yang ditetapkan untuk akun (jika berlaku). %APP_NAME% - Nama tampilan project Google Cloud. %DISPLAY_NAME% - Nama tampilan pengguna.

Representasi JSON 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Kolom
senderLocalPart

string

Bagian lokal dari alamat Pengirim
subject

string

Subjek email
senderDisplayName

string

Nama tampilan pengirim
body

string

Isi email
bodyFormat

enum (BodyFormat)

Format isi email
replyTo

string

Alamat balas-ke
customized

boolean

Hanya output. Apakah isi atau subjek email disesuaikan.

BodyFormat

Format isi email

Enum
BODY_FORMAT_UNSPECIFIED Nilai default. Jangan gunakan.
PLAIN_TEXT Teks biasa
HTML HTML

DnsInfo

Informasi verifikasi DNS domain kustom. Secara default, default_domain akan digunakan. Domain kustom dapat dikonfigurasi menggunakan VerifyCustomDomain.

Representasi JSON 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Kolom
customDomain

string

Hanya output. Domain kustom terverifikasi yang diterapkan.
useCustomDomain

boolean

Apakah akan menggunakan domain kustom.
pendingCustomDomain

string

Hanya output. Domain kustom yang akan diverifikasi.
customDomainState

enum (VerificationState)

Hanya output. Status verifikasi domain kustom saat ini. Domain kustom hanya akan digunakan setelah verifikasi domain berhasil.
domainVerificationRequestTime

string (Timestamp format)

Hanya output. Stempel waktu permintaan awal untuk verifikasi domain saat ini.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

SendSms

Opsi untuk pengiriman SMS.

Representasi JSON 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Kolom
useDeviceLocale

boolean

Apakah akan menggunakan header accept_language untuk SMS.
smsTemplate

object (SmsTemplate)

Hanya output. Template yang akan digunakan saat mengirim SMS.

SmsTemplate

Template yang akan digunakan saat mengirim SMS.

Representasi JSON 
{
  "content": string
}
Kolom
content

string

Hanya output. Konten SMS. Dapat berisi placeholder berikut yang akan diganti dengan nilai yang sesuai: %APP_NAME% - Untuk aplikasi Android atau iOS, nama tampilan aplikasi. Untuk aplikasi web, domain yang menghosting aplikasi. %LOGIN_CODE% - Kode OOB yang dikirim dalam SMS.

QuotaConfig

Konfigurasi yang terkait dengan kuota.

Representasi JSON 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Kolom
signUpQuotaConfig

object (TemporaryQuota)

Kuota untuk endpoint Pendaftaran, jika ditimpa. Kuota pendaftaran diukur dalam pendaftaran per project per jam per IP.

TemporaryQuota

Kenaikan / penurunan kuota sementara

Representasi JSON 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Kolom
quota

string (int64 format)

Sesuai dengan kolom 'refill_token_count' di konfigurasi QuotaServer
startTime

string (Timestamp format)

Kapan kuota ini akan berlaku

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
quotaDuration

string (Duration format)

Durasi aktif kuota ini

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".

MultiTenantConfig

Konfigurasi yang terkait dengan fungsi multi-tenant.

Representasi JSON 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Kolom
allowTenants

boolean

Apakah project ini dapat memiliki tenant atau tidak.
defaultTenantLocation

string

Organisasi atau folder induk cloud default tempat project tenant harus dibuat. Nama resource induk harus dalam format "/", seperti "folders/123" atau "organizations/456". Jika nilai tidak ditetapkan, tenant akan dibuat di organisasi atau folder yang sama dengan project agen.

Subjenis

Subjenis konfigurasi ini.

Enum
SUBTYPE_UNSPECIFIED Nilai default. Jangan gunakan.
IDENTITY_PLATFORM Project Identity Platform.
FIREBASE_AUTH Project Firebase Authentication.

ClientConfig

Opsi terkait cara klien membuat permintaan atas nama project harus dikonfigurasi.

Representasi JSON 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Kolom
apiKey

string

Hanya output. Kunci API yang dapat digunakan saat membuat permintaan untuk project ini.
permissions

object (Permissions)

Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya.
firebaseSubdomain

string

Hanya output. Subdomain Firebase.

Izin

Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya.

Representasi JSON 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Kolom
disabledUserSignup

boolean

Jika benar (true), pengguna akhir tidak dapat mendaftar ke akun baru di project terkait melalui metode API kami
disabledUserDeletion

boolean

Jika benar, pengguna akhir tidak dapat menghapus akun mereka di project terkait melalui metode API kami

BlockingFunctionsConfig

Konfigurasi yang terkait dengan Pemblokiran Functions.

Representasi JSON 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Kolom
triggers

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

Peta Pemicu ke jenis peristiwa. Kunci harus berupa salah satu jenis peristiwa yang didukung: "beforeCreate", "beforeSignIn"

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardInboundCredentials

object (ForwardInboundCredentials)

Kredensial pengguna yang akan disertakan dalam payload JWT yang dikirim ke Fungsi Pemblokiran terdaftar.

Pemicu

Cloud Function Sinkron dengan Pemicu HTTP

Representasi JSON 
{
  "functionUri": string,
  "updateTime": string
}
Kolom
functionUri

string

Pemicu URI HTTP untuk Cloud Function.
updateTime

string (Timestamp format)

Saat pemicu diubah.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

ForwardInboundCredentials

Menunjukkan kredensial yang akan diteruskan ke Blocking Functions yang terdaftar.

Representasi JSON 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Kolom
idToken

boolean

Apakah akan meneruskan token ID penyedia identitas OIDC pengguna.
accessToken

boolean

Apakah akan meneruskan token akses penyedia identitas OAuth pengguna.
refreshToken

boolean

Apakah akan meneruskan token refresh penyedia identitas OAuth pengguna.