- Resource: Tenant
- HashConfig
- HashAlgorithm
- MultiFactorAuthConfig
- Status
- Penyedia
- ProviderConfig
- TotpMfaProviderConfig
- MfaState
- Pewarisan
- RecaptchaConfig
- RecaptchaProviderEnforcementState
- RecaptchaManagedRule
- RecaptchaAction
- RecaptchaKey
- RecaptchaKeyClientType
- RecaptchaTollFraudManagedRule
- RecaptchaAction
- SmsRegionConfig
- AllowByDefault
- AllowlistOnly
- MonitoringConfig
- RequestLogging
- PasswordPolicyConfig
- PasswordPolicyEnforcementState
- PasswordPolicyVersion
- CustomStrengthOptions
- EmailPrivacyConfig
- ClientPermissionConfig
- ClientPermissions
- MobileLinksConfig
- Domain
- Metode
Resource: Tenant
Tenant berisi konfigurasi untuk tenant dalam project multi-tenant.
Representasi JSON |
---|
{ "name": string, "displayName": string, "allowPasswordSignup": boolean, "enableEmailLinkSignin": boolean, "disableAuth": boolean, "hashConfig": { object ( |
Kolom | |
---|---|
name |
Hanya output. Nama resource tenant. Misalnya: "projects/{project-id}/tenants/{tenant-id}" |
displayName |
Nama tampilan tenant. |
allowPasswordSignup |
Apakah akan mengizinkan autentikasi pengguna email/sandi. |
enableEmailLinkSignin |
Apakah akan mengaktifkan autentikasi pengguna link email. |
disableAuth |
Apakah autentikasi dinonaktifkan untuk tenant. Jika benar, pengguna di bawah tenant yang dinonaktifkan tidak diizinkan untuk login. Admin tenant yang dinonaktifkan tidak dapat mengelola penggunanya. |
hashConfig |
Hanya output. Informasi konfigurasi hash tenant untuk ditampilkan di Pantheon. Informasi ini hanya dapat ditampilkan di Pantheon untuk menghindari kebocoran informasi sensitif secara tidak sengaja. Hanya ditampilkan dalam respons tenants.get untuk membatasi pembacaan informasi ini. Memerlukan izin firebaseauth.configs.getHashConfig di project agen untuk menampilkan kolom ini. |
enableAnonymousUser |
Apakah akan mengaktifkan autentikasi pengguna anonim. |
mfaConfig |
Konfigurasi opsi MFA tingkat tenant. |
testPhoneNumbers |
Peta pasangan <nomor telepon pengujian, kode palsu> yang dapat digunakan untuk MFA. Nomor telepon harus dalam format E.164 (https://www.itu.int/rec/T-REC-E.164/) dan maksimum 10 pasangan dapat ditambahkan (error akan ditampilkan setelah batas terlampaui). Objek yang berisi daftar pasangan |
inheritance |
Tentukan setelan yang dapat diwarisi tenant. |
recaptchaConfig |
Konfigurasi reCAPTCHA tingkat tenant. |
smsRegionConfig |
Mengonfigurasi wilayah yang diaktifkan untuk pengiriman kode verifikasi SMS. |
autodeleteAnonymousUsers |
Apakah pengguna anonim akan otomatis dihapus setelah periode 30 hari. |
monitoring |
Konfigurasi yang terkait dengan pemantauan aktivitas project. |
passwordPolicyConfig |
Konfigurasi kebijakan sandi tingkat tenant |
emailPrivacyConfig |
Konfigurasi untuk setelan yang terkait dengan privasi email dan visibilitas publik. |
client |
Opsi terkait cara klien membuat permintaan atas nama project harus dikonfigurasi. |
mobileLinksConfig |
Opsional. Tidak digunakan lagi. Tidak pernah diluncurkan. Konfigurasi untuk setelan yang terkait dengan link universal (iOS) dan link aplikasi (Android). |
HashConfig
Informasi histori algoritma dan kunci hash. Sandi akun yang berbeda dapat dibuat oleh versi yang berbeda.
Representasi JSON |
---|
{
"algorithm": enum ( |
Kolom | |
---|---|
algorithm |
Hanya output. Berbagai algoritma hash sandi yang digunakan di Identity Toolkit. |
signerKey |
Hanya output. Kunci penanda tangan dalam base64. |
saltSeparator |
Hanya output. Karakter yang tidak dapat dicetak yang akan disisipkan di antara salt dan sandi teks biasa dalam base64. |
rounds |
Hanya output. Jumlah putaran untuk penghitungan hash. Digunakan oleh scrypt dan algoritma turunan sandi serupa lainnya. |
memoryCost |
Hanya output. Biaya memori untuk penghitungan hash. Digunakan oleh scrypt dan algoritma turunan sandi serupa lainnya. Lihat https://tools.ietf.org/html/rfc7914 untuk mengetahui penjelasan kolom. |
HashAlgorithm
Berbagai algoritma hash sandi yang digunakan di Identity Toolkit.
Enum | |
---|---|
HASH_ALGORITHM_UNSPECIFIED |
Nilai default. Jangan gunakan. |
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 |
MultiFactorAuthConfig
Opsi yang terkait dengan Autentikasi Multi-Faktor untuk project.
Representasi JSON |
---|
{ "state": enum ( |
Kolom | |
---|---|
state |
Apakah Autentikasi Multi-Faktor telah diaktifkan untuk project ini. |
enabledProviders[] |
Daftar faktor kedua yang dapat digunakan untuk project ini. |
providerConfigs[] |
Daftar faktor kedua yang dapat digunakan untuk project ini beserta konfigurasinya. Kolom ini tidak mendukung MFA berbasis telepon, untuk itu gunakan kolom 'enabledProviders'. |
Negara bagian/Provinsi
Apakah Autentikasi Multi-Faktor telah diaktifkan untuk project ini.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status Ilegal, tidak boleh digunakan. |
DISABLED |
Autentikasi multi-faktor tidak dapat digunakan untuk project ini |
ENABLED |
Autentikasi multi-faktor dapat digunakan untuk project ini |
MANDATORY |
Autentikasi multi-faktor diperlukan untuk project ini. Pengguna dari project ini harus melakukan autentikasi dengan faktor kedua. |
Penyedia
Daftar faktor kedua yang dapat digunakan untuk project ini.
Enum | |
---|---|
PROVIDER_UNSPECIFIED |
Penyedia Ilegal, tidak boleh digunakan |
PHONE_SMS |
SMS diaktifkan sebagai faktor kedua untuk project ini. |
ProviderConfig
ProviderConfig menjelaskan penyedia MFA yang didukung beserta konfigurasinya.
Representasi JSON |
---|
{ "state": enum ( |
Kolom | |
---|---|
state |
Menjelaskan status jenis Autentikasi Multi-Faktor. |
Kolom union
|
|
totpProviderConfig |
Konfigurasi penyedia MFA TOTP untuk project ini. |
TotpMfaProviderConfig
TotpMFAProviderConfig mewakili penyedia MFA berbasis TOTP.
Representasi JSON |
---|
{ "adjacentIntervals": integer } |
Kolom | |
---|---|
adjacentIntervals |
Jumlah interval yang berdekatan yang diizinkan dan akan digunakan untuk verifikasi guna menghindari skew clock. |
MfaState
Apakah Autentikasi Multi-Faktor telah diaktifkan untuk project ini.
Enum | |
---|---|
MFA_STATE_UNSPECIFIED |
Status Ilegal, tidak boleh digunakan. |
DISABLED |
Autentikasi multi-faktor tidak dapat digunakan untuk project ini. |
ENABLED |
Autentikasi multi-faktor dapat digunakan untuk project ini. |
MANDATORY |
Autentikasi multi-faktor diperlukan untuk project ini. Pengguna dari project ini harus melakukan autentikasi dengan faktor kedua. |
Pewarisan
Setelan yang akan diwarisi tenant dari level project.
Representasi JSON |
---|
{ "emailSendingConfig": boolean } |
Kolom | |
---|---|
emailSendingConfig |
Apakah akan mengizinkan tenant mewarisi domain kustom, template email, dan setelan SMTP kustom. Jika benar, email yang dikirim dari tenant akan mengikuti konfigurasi pengiriman email tingkat project. Jika salah (secara default), email akan menggunakan setelan default tanpa penyesuaian. |
RecaptchaConfig
Konfigurasi integrasi reCAPTCHA Enterprise.
Representasi JSON |
---|
{ "managedRules": [ { object ( |
Kolom | |
---|---|
managedRules[] |
Aturan terkelola untuk tindakan autentikasi berdasarkan skor reCAPTCHA. Aturan dibagikan di seluruh penyedia untuk project tenant tertentu. |
recaptchaKeys[] |
Kunci reCAPTCHA. |
tollFraudManagedRules[] |
Aturan terkelola untuk tindakan autentikasi berdasarkan skor risiko penipuan pulsa reCAPTCHA. Aturan yang dikelola penipuan tol hanya akan berlaku jika phoneEnforcementState adalah AUDIT atau ENFORCE dan useSmsTollFraudProtection adalah benar. |
emailPasswordEnforcementState |
Konfigurasi reCAPTCHA untuk penyedia email/sandi, yang berisi status penerapan. Penyedia email/sandi berisi semua alur penggunaan terkait email yang dilindungi oleh reCAPTCHA. |
useAccountDefender |
Apakah akan menggunakan pelindung akun untuk penilaian reCAPTCHA. Nilai defaultnya adalah |
phoneEnforcementState |
Konfigurasi reCAPTCHA untuk penyedia ponsel, yang berisi status penerapan. Penyedia telepon berisi semua alur penggunaan terkait SMS yang dilindungi oleh reCAPTCHA. |
useSmsBotScore |
Apakah akan menggunakan skor bot rCE untuk penyedia telepon reCAPTCHA. Hanya dapat bernilai benar jika phoneEnforcementState adalah AUDIT atau ENFORCE. |
useSmsTollFraudProtection |
Apakah akan menggunakan skor risiko perlindungan terhadap penipuan pulsa SMS rCE untuk penyedia telepon reCAPTCHA. Hanya dapat bernilai benar jika phoneEnforcementState adalah AUDIT atau ENFORCE. |
RecaptchaProviderEnforcementState
Status penerapan untuk perlindungan reCAPTCHA.
Enum | |
---|---|
RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED |
Status penegakan belum ditetapkan. |
OFF |
Tidak diterapkan. |
AUDIT |
Penilaian reCAPTCHA dibuat, hasilnya tidak digunakan untuk diterapkan. |
ENFORCE |
Penilaian reCAPTCHA dibuat, hasilnya digunakan untuk diterapkan. |
RecaptchaManagedRule
Konfigurasi untuk aturan yang dikelola reCAPTCHA. Membuat model satu interval [startScore, endScore]. startScore bersifat implisit. Nilai ini adalah endScore terdekat yang lebih kecil (jika tersedia) atau 0. Interval dalam rentang gabungan [0, 1] tanpa tumpang-tindih.
Representasi JSON |
---|
{
"endScore": number,
"action": enum ( |
Kolom | |
---|---|
endScore |
Skor akhir (inklusif) dari rentang skor untuk suatu tindakan. Harus berupa nilai antara 0,0 dan 1,0, dengan 11 nilai terpisah; misalnya, 0, 0,1, 0,2, 0,3, ... 0,9, 1,0. Skor 0,0 menunjukkan permintaan yang paling berisiko (kemungkinan bot), sedangkan 1,0 menunjukkan permintaan yang paling aman (kemungkinan manusia). Lihat https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment. |
action |
Tindakan yang diambil jika skor reCAPTCHA permintaan berada dalam interval [startScore, endScore]. |
RecaptchaAction
Tindakan untuk permintaan yang dilindungi reCAPTCHA.
Enum | |
---|---|
RECAPTCHA_ACTION_UNSPECIFIED |
Tindakan reCAPTCHA tidak ditentukan. |
BLOCK |
Permintaan yang dilindungi reCAPTCHA akan diblokir. |
RecaptchaKey
Konfigurasi kunci reCAPTCHA. reCAPTCHA Enterprise menawarkan kunci yang berbeda untuk platform klien yang berbeda.
Representasi JSON |
---|
{
"key": string,
"type": enum ( |
Kolom | |
---|---|
key |
Nama resource kunci reCAPTCHA Enterprise, misalnya "projects/{project}/keys/{key}" |
type |
Jenis platform klien. |
RecaptchaKeyClientType
Berbagai klien yang didukung kunci reCAPTCHA Enterprise.
Enum | |
---|---|
CLIENT_TYPE_UNSPECIFIED |
Jenis klien tidak ditentukan. |
WEB |
Jenis klien adalah web. |
IOS |
Jenis klien adalah iOS. |
ANDROID |
Jenis klien adalah Android. |
RecaptchaTollFraudManagedRule
Konfigurasi untuk aturan terkelola penilaian penipuan tol reCAPTCHA. Membuat model satu interval [startScore, endScore]. endScore bersifat implisit. Nilai ini adalah endScore terdekat yang lebih kecil (jika tersedia) atau 0. Interval dalam rentang gabungan [0, 1] tanpa tumpang-tindih.
Representasi JSON |
---|
{
"startScore": number,
"action": enum ( |
Kolom | |
---|---|
startScore |
Skor awal (inklusif) untuk suatu tindakan. Harus berupa nilai antara 0,0 dan 1,0, dengan 11 nilai terpisah; misalnya, 0, 0,1, 0,2, 0,3, ... 0,9, 1,0. Skor 0,0 menunjukkan permintaan teraman (kemungkinan sah), sedangkan 1,0 menunjukkan permintaan berisiko tinggi (kemungkinan penipuan tol). Lihat https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms. |
action |
Tindakan yang diambil jika skor reCAPTCHA permintaan berada dalam interval [startScore, endScore]. |
RecaptchaAction
Setelan defaultnya adalah RECAPTCHA_ACTION_UNSPECIFIED
Enum | |
---|---|
RECAPTCHA_ACTION_UNSPECIFIED |
Tindakan reCAPTCHA tidak ditentukan. |
BLOCK |
Permintaan yang dilindungi reCAPTCHA akan diblokir. |
SmsRegionConfig
Mengonfigurasi wilayah tempat pengguna diizinkan mengirim SMS verifikasi untuk project atau tenant. Hal ini didasarkan pada kode telepon nomor telepon tujuan.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union sms_region_policy . Kebijakan untuk tempat pengguna diizinkan mengirim SMS verifikasi. Tindakan ini dapat berupa mengizinkan semua wilayah secara default atau mengizinkan wilayah hanya dengan daftar yang diizinkan secara eksplisit. sms_region_policy hanya ada berupa salah satu diantara berikut: |
|
allowByDefault |
Kebijakan yang mengizinkan SMS ke setiap wilayah secara default dan menambahkan wilayah yang tidak diizinkan ke daftar yang tidak diizinkan. |
allowlistOnly |
Kebijakan yang hanya mengizinkan wilayah dengan menambahkannya secara eksplisit ke daftar yang diizinkan. |
AllowByDefault
Menentukan kebijakan untuk mengizinkan setiap wilayah secara default dan menambahkan wilayah yang tidak diizinkan ke daftar yang tidak diizinkan.
Representasi JSON |
---|
{ "disallowedRegions": [ string ] } |
Kolom | |
---|---|
disallowedRegions[] |
Kode wilayah unicode dua huruf yang tidak diizinkan seperti yang ditentukan oleh https://cldr.unicode.org/ Daftar lengkap kode wilayah ini ada di sini: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json |
AllowlistOnly
Menentukan kebijakan untuk hanya mengizinkan wilayah dengan menambahkannya secara eksplisit ke daftar yang diizinkan.
Representasi JSON |
---|
{ "allowedRegions": [ string ] } |
Kolom | |
---|---|
allowedRegions[] |
Kode wilayah unicode dua huruf yang diizinkan seperti yang ditentukan oleh https://cldr.unicode.org/ Daftar lengkap kode wilayah ini ada di sini: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json |
MonitoringConfig
Konfigurasi yang terkait dengan pemantauan aktivitas project.
Representasi JSON |
---|
{
"requestLogging": {
object ( |
Kolom | |
---|---|
requestLogging |
Konfigurasi untuk logging permintaan yang dibuat ke project ini ke Stackdriver Logging |
RequestLogging
Konfigurasi untuk logging permintaan yang dibuat ke project ini ke Stackdriver Logging
Representasi JSON |
---|
{ "enabled": boolean } |
Kolom | |
---|---|
enabled |
Apakah logging diaktifkan untuk project ini atau tidak. |
PasswordPolicyConfig
Konfigurasi untuk kebijakan sandi di project.
Representasi JSON |
---|
{ "passwordPolicyEnforcementState": enum ( |
Kolom | |
---|---|
passwordPolicyEnforcementState |
Mode penerapan yang akan digunakan untuk kebijakan sandi. |
passwordPolicyVersions[] |
Harus memiliki panjang 1. Berisi atribut kekuatan untuk kebijakan sandi. |
forceUpgradeOnSignin |
Pengguna harus memiliki sandi yang mematuhi kebijakan sandi untuk login. |
lastUpdateTime |
Hanya output. Terakhir kali kebijakan sandi di project diperbarui. 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: |
PasswordPolicyEnforcementState
Status penerapan untuk kebijakan sandi
Enum | |
---|---|
PASSWORD_POLICY_ENFORCEMENT_STATE_UNSPECIFIED |
Status Ilegal, tidak boleh digunakan. |
OFF |
Kebijakan Sandi tidak akan digunakan pada project. |
ENFORCE |
Sandi yang tidak mematuhi kebijakan sandi akan ditolak dengan error yang ditampilkan. |
PasswordPolicyVersion
Atribut kekuatan untuk kebijakan sandi di project.
Representasi JSON |
---|
{
"customStrengthOptions": {
object ( |
Kolom | |
---|---|
customStrengthOptions |
Opsi kekuatan kustom yang diterapkan oleh kebijakan sandi. |
schemaVersion |
Hanya output. nomor versi skema untuk kebijakan sandi |
CustomStrengthOptions
Opsi kekuatan kustom untuk diterapkan pada sandi pengguna.
Representasi JSON |
---|
{ "minPasswordLength": integer, "maxPasswordLength": integer, "containsLowercaseCharacter": boolean, "containsUppercaseCharacter": boolean, "containsNumericCharacter": boolean, "containsNonAlphanumericCharacter": boolean } |
Kolom | |
---|---|
minPasswordLength |
Panjang sandi minimum. Rentang dari 6 hingga 30 |
maxPasswordLength |
Panjang sandi maksimum. Tidak ada durasi maksimal default |
containsLowercaseCharacter |
Sandi harus mengandung karakter huruf kecil. |
containsUppercaseCharacter |
Sandi harus mengandung karakter huruf besar. |
containsNumericCharacter |
Sandi harus berisi angka. |
containsNonAlphanumericCharacter |
Sandi harus berisi karakter non-alfanumerik. |
EmailPrivacyConfig
Konfigurasi untuk setelan yang terkait dengan privasi email dan visibilitas publik. Setelan dalam konfigurasi ini melindungi terhadap enumerasi email, tetapi dapat membuat beberapa kompromi dalam kemudahan penggunaan.
Representasi JSON |
---|
{ "enableImprovedEmailPrivacy": boolean } |
Kolom | |
---|---|
enableImprovedEmailPrivacy |
Memigrasikan project ke status privasi email yang lebih baik. Misalnya, kode error tertentu lebih umum untuk menghindari pemberian informasi tentang apakah akun tersebut ada. Selain itu, tindakan ini menonaktifkan fitur tertentu yang sebagai efek sampingnya mengizinkan enumerasi pengguna. Mengaktifkan tombol ini akan menonaktifkan fungsi fetchSignInMethodsForEmail dan mengubah email pengguna menjadi email yang tidak terverifikasi. Sebaiknya hapus dependensi pada fungsi ini dan aktifkan tombol ini untuk meningkatkan privasi pengguna. |
ClientPermissionConfig
Opsi terkait cara mengonfigurasi klien yang membuat permintaan atas nama tenant.
Representasi JSON |
---|
{
"permissions": {
object ( |
Kolom | |
---|---|
permissions |
Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya. |
ClientPermissions
Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya.
Representasi JSON |
---|
{ "disabledUserSignup": boolean, "disabledUserDeletion": boolean } |
Kolom | |
---|---|
disabledUserSignup |
Jika benar (true), pengguna akhir tidak dapat mendaftar ke akun baru di project terkait melalui metode API kami |
disabledUserDeletion |
Jika benar, pengguna akhir tidak dapat menghapus akun mereka di project terkait melalui metode API kami |
MobileLinksConfig
Link seluler konfigurasi.
Representasi JSON |
---|
{
"domain": enum ( |
Kolom | |
---|---|
domain |
Membuka kode di domain aplikasi untuk digunakan untuk link aplikasi dan link universal. |
Domain
Kemungkinan kode terbuka di domain aplikasi yang akan digunakan untuk link aplikasi dan link universal.
Enum | |
---|---|
DOMAIN_UNSPECIFIED |
Nilai default. Domain default adalah domain Firebase Dynamic Links sebelum penghentian FDL dan domain hosting setelah penghentian FDL. |
FIREBASE_DYNAMIC_LINK_DOMAIN |
Menggunakan domain Firebase Dynamic Link sebagai domain link aplikasi. Nilai default. |
HOSTING_DOMAIN |
Menggunakan domain hosting sebagai domain link aplikasi. |
Metode |
|
---|---|
|
Buat tenant. |
|
Menghapus tenant. |
|
Mendapatkan tenant. |
|
Mendapatkan kebijakan kontrol akses untuk resource. |
|
Mencantumkan tenant dalam project agen tertentu. |
|
Memperbarui tenant. |
|
Menetapkan kebijakan kontrol akses untuk resource. |
|
Menampilkan izin pemanggil pada resource. |