REST Resource: projects.tenants

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 (HashConfig)
  },
  "enableAnonymousUser": boolean,
  "mfaConfig": {
    object (MultiFactorAuthConfig)
  },
  "testPhoneNumbers": {
    string: string,
    ...
  },
  "inheritance": {
    object (Inheritance)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "monitoring": {
    object (MonitoringConfig)
  },
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "client": {
    object (ClientPermissionConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  }
}
Kolom
name

string

Hanya output. Nama resource tenant. Misalnya: "projects/{project-id}/tenants/{tenant-id}"

displayName

string

Nama tampilan tenant.

allowPasswordSignup

boolean

Apakah akan mengizinkan autentikasi pengguna email/sandi.

disableAuth

boolean

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

object (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

boolean

Apakah akan mengaktifkan autentikasi pengguna anonim.

mfaConfig

object (MultiFactorAuthConfig)

Konfigurasi opsi MFA tingkat tenant.

testPhoneNumbers

map (key: string, value: string)

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 "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

inheritance

object (Inheritance)

Tentukan setelan yang dapat diwarisi tenant.

recaptchaConfig

object (RecaptchaConfig)

Konfigurasi reCAPTCHA tingkat tenant.

smsRegionConfig

object (SmsRegionConfig)

Mengonfigurasi wilayah yang diaktifkan untuk pengiriman kode verifikasi SMS.

autodeleteAnonymousUsers

boolean

Apakah pengguna anonim akan otomatis dihapus setelah periode 30 hari.

monitoring

object (MonitoringConfig)

Konfigurasi yang terkait dengan pemantauan aktivitas project.

passwordPolicyConfig

object (PasswordPolicyConfig)

Konfigurasi kebijakan sandi tingkat tenant

emailPrivacyConfig

object (EmailPrivacyConfig)

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

client

object (ClientPermissionConfig)

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

HashConfig

Informasi histori algoritma dan kunci hash. Sandi akun yang berbeda dapat dibuat oleh versi yang berbeda.

Representasi JSON
{
  "algorithm": enum (HashAlgorithm),
  "signerKey": string,
  "saltSeparator": string,
  "rounds": integer,
  "memoryCost": integer
}
Kolom
algorithm

enum (HashAlgorithm)

Hanya output. Berbagai algoritma hash sandi yang digunakan di Identity Toolkit.

signerKey

string

Hanya output. Kunci penanda tangan dalam base64.

saltSeparator

string

Hanya output. Karakter yang tidak dapat dicetak yang akan disisipkan di antara salt dan sandi teks biasa dalam base64.

rounds

integer

Hanya output. Jumlah putaran untuk penghitungan hash. Digunakan oleh scrypt dan algoritma turunan sandi serupa lainnya.

memoryCost

integer

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 (State),
  "enabledProviders": [
    enum (Provider)
  ],
  "providerConfigs": [
    {
      object (ProviderConfig)
    }
  ]
}
Kolom
state

enum (State)

Apakah Autentikasi Multi-Faktor telah diaktifkan untuk project ini.

enabledProviders[]

enum (Provider)

Daftar faktor kedua yang dapat digunakan untuk project ini.

providerConfigs[]

object (ProviderConfig)

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 (MfaState),

  // Union field mfa_provider_config can be only one of the following:
  "totpProviderConfig": {
    object (TotpMfaProviderConfig)
  }
  // End of list of possible types for union field mfa_provider_config.
}
Kolom
state

enum (MfaState)

Menjelaskan status jenis Autentikasi Multi-Faktor.

Kolom union mfa_provider_config.

mfa_provider_config hanya dapat berupa salah satu dari hal berikut:

totpProviderConfig

object (TotpMfaProviderConfig)

Konfigurasi penyedia MFA TOTP untuk project ini.

TotpMfaProviderConfig

TotpMFAProviderConfig mewakili penyedia MFA berbasis TOTP.

Representasi JSON
{
  "adjacentIntervals": integer
}
Kolom
adjacentIntervals

integer

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

boolean

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 (RecaptchaManagedRule)
    }
  ],
  "recaptchaKeys": [
    {
      object (RecaptchaKey)
    }
  ],
  "tollFraudManagedRules": [
    {
      object (RecaptchaTollFraudManagedRule)
    }
  ],
  "emailPasswordEnforcementState": enum (RecaptchaProviderEnforcementState),
  "useAccountDefender": boolean,
  "phoneEnforcementState": enum (RecaptchaProviderEnforcementState),
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Kolom
managedRules[]

object (RecaptchaManagedRule)

Aturan terkelola untuk tindakan autentikasi berdasarkan skor reCAPTCHA. Aturan dibagikan di seluruh penyedia untuk project tenant tertentu.

recaptchaKeys[]

object (RecaptchaKey)

Kunci reCAPTCHA.

tollFraudManagedRules[]

object (RecaptchaTollFraudManagedRule)

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

enum (RecaptchaProviderEnforcementState)

Konfigurasi reCAPTCHA untuk penyedia email/sandi, yang berisi status penerapan. Penyedia email/sandi berisi semua alur penggunaan terkait email yang dilindungi oleh reCAPTCHA.

useAccountDefender

boolean

Apakah akan menggunakan pelindung akun untuk penilaian reCAPTCHA. Nilai defaultnya adalah false.

phoneEnforcementState

enum (RecaptchaProviderEnforcementState)

Konfigurasi reCAPTCHA untuk penyedia ponsel, yang berisi status penerapan. Penyedia telepon berisi semua alur penggunaan terkait SMS yang dilindungi oleh reCAPTCHA.

useSmsBotScore

boolean

Apakah akan menggunakan skor bot rCE untuk penyedia telepon reCAPTCHA. Hanya dapat bernilai benar jika phoneEnforcementState adalah AUDIT atau ENFORCE.

useSmsTollFraudProtection

boolean

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 (RecaptchaAction)
}
Kolom
endScore

number

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

enum (RecaptchaAction)

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 (RecaptchaKeyClientType)
}
Kolom
key

string

Nama resource kunci reCAPTCHA Enterprise, misalnya "projects/{project}/keys/{key}"

type

enum (RecaptchaKeyClientType)

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 (RecaptchaAction)
}
Kolom
startScore

number

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

enum (RecaptchaAction)

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 sms_region_policy can be only one of the following:
  "allowByDefault": {
    object (AllowByDefault)
  },
  "allowlistOnly": {
    object (AllowlistOnly)
  }
  // End of list of possible types for union field sms_region_policy.
}
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

object (AllowByDefault)

Kebijakan yang mengizinkan SMS ke setiap wilayah secara default dan menambahkan wilayah yang tidak diizinkan ke daftar yang tidak diizinkan.

allowlistOnly

object (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[]

string

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[]

string

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 (RequestLogging)
  }
}
Kolom
requestLogging

object (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

boolean

Apakah logging diaktifkan untuk project ini atau tidak.

PasswordPolicyConfig

Konfigurasi untuk kebijakan sandi di project.

Representasi JSON
{
  "passwordPolicyEnforcementState": enum (PasswordPolicyEnforcementState),
  "passwordPolicyVersions": [
    {
      object (PasswordPolicyVersion)
    }
  ],
  "forceUpgradeOnSignin": boolean,
  "lastUpdateTime": string
}
Kolom
passwordPolicyEnforcementState

enum (PasswordPolicyEnforcementState)

Mode penerapan yang akan digunakan untuk kebijakan sandi.

passwordPolicyVersions[]

object (PasswordPolicyVersion)

Harus memiliki panjang 1. Berisi atribut kekuatan untuk kebijakan sandi.

forceUpgradeOnSignin

boolean

Pengguna harus memiliki sandi yang mematuhi kebijakan sandi untuk login.

lastUpdateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

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 (CustomStrengthOptions)
  },
  "schemaVersion": integer
}
Kolom
customStrengthOptions

object (CustomStrengthOptions)

Opsi kekuatan kustom yang diterapkan oleh kebijakan sandi.

schemaVersion

integer

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

integer

Panjang sandi minimum. Rentang dari 6 hingga 30

maxPasswordLength

integer

Panjang sandi maksimum. Tidak ada durasi maksimal default

containsLowercaseCharacter

boolean

Sandi harus mengandung karakter huruf kecil.

containsUppercaseCharacter

boolean

Sandi harus mengandung karakter huruf besar.

containsNumericCharacter

boolean

Sandi harus berisi angka.

containsNonAlphanumericCharacter

boolean

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

boolean

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 (ClientPermissions)
  }
}
Kolom
permissions

object (ClientPermissions)

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

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

MobileLinksConfig

Link seluler konfigurasi.

Representasi JSON
{
  "domain": enum (Domain)
}
Kolom
domain

enum (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.
HOSTING_DOMAIN Menggunakan domain hosting sebagai domain link aplikasi.

Metode

create

Buat tenant.

delete

Menghapus tenant.

get

Mendapatkan tenant.

getIamPolicy

Mendapatkan kebijakan kontrol akses untuk resource.

list

Mencantumkan tenant dalam project agen tertentu.

patch

Memperbarui tenant.

setIamPolicy

Menetapkan kebijakan kontrol akses untuk resource.

testIamPermissions

Menampilkan izin pemanggil pada resource.