Indeks
ProjectConfigService
(grafis)TenantManagementService
(grafis)BlockingFunctionsConfig
(pesan)BlockingFunctionsConfig.Trigger
(pesan)ClientConfig
(pesan)ClientConfig.Permissions
(pesan)Config
(pesan)Config.Subtype
(enum)CreateDefaultSupportedIdpConfigRequest
(pesan)CreateInboundSamlConfigRequest
(pesan)CreateOAuthIdpConfigRequest
(pesan)CreateTenantRequest
(pesan)DefaultSupportedIdp
(pesan)DefaultSupportedIdpConfig
(pesan)DeleteDefaultSupportedIdpConfigRequest
(pesan)DeleteInboundSamlConfigRequest
(pesan)DeleteOAuthIdpConfigRequest
(pesan)DeleteTenantRequest
(pesan)EnableCicpRequest
(pesan)EnableCicpResponse
(pesan)GetConfigRequest
(pesan)GetDefaultSupportedIdpConfigRequest
(pesan)GetInboundSamlConfigRequest
(pesan)GetOAuthIdpConfigRequest
(pesan)GetTenantRequest
(pesan)HashConfig
(pesan)HashConfig.HashAlgorithm
(enum)IdpCertificate
(pesan)InboundSamlConfig
(pesan)InboundSamlConfig.IdpConfig
(pesan)InboundSamlConfig.SpConfig
(pesan)ListDefaultSupportedIdpConfigsRequest
(pesan)ListDefaultSupportedIdpConfigsResponse
(pesan)ListDefaultSupportedIdpsRequest
(pesan)ListDefaultSupportedIdpsResponse
(pesan)ListInboundSamlConfigsRequest
(pesan)ListInboundSamlConfigsResponse
(pesan)ListOAuthIdpConfigsRequest
(pesan)ListOAuthIdpConfigsResponse
(pesan)ListTenantsRequest
(pesan)ListTenantsResponse
(pesan)MonitoringConfig
(pesan)MonitoringConfig.RequestLogging
(pesan)MultiFactorAuthConfig
(pesan)MultiFactorAuthConfig.Provider
(enum)MultiFactorAuthConfig.State
(enum)NotificationConfig
(pesan)NotificationConfig.SendEmail
(pesan)NotificationConfig.SendEmail.DnsInfo
(pesan)NotificationConfig.SendEmail.DnsInfo.VerificationState
(enum)NotificationConfig.SendEmail.EmailTemplate
(pesan)NotificationConfig.SendEmail.EmailTemplate.BodyFormat
(enum)NotificationConfig.SendEmail.Method
(enum)NotificationConfig.SendEmail.Smtp
(pesan)NotificationConfig.SendEmail.Smtp.SecurityMode
(enum)NotificationConfig.SendSms
(pesan)NotificationConfig.SendSms.SmsTemplate
(pesan)OAuthIdpConfig
(pesan)OAuthIdpConfig.OAuthResponseType
(pesan)QuotaConfig
(pesan)QuotaConfig.TemporaryQuota
(pesan)SignInConfig
(pesan)SignInConfig.Anonymous
(pesan)SignInConfig.Email
(pesan)SignInConfig.PhoneNumber
(pesan)SpCertificate
(pesan)Tenant
(pesan)UpdateConfigRequest
(pesan)UpdateDefaultSupportedIdpConfigRequest
(pesan)UpdateInboundSamlConfigRequest
(pesan)UpdateOAuthIdpConfigRequest
(pesan)UpdateTenantRequest
(pesan)VerifyDomainRequest
(pesan)VerifyDomainRequest.DomainVerificationAction
(enum)VerifyDomainResponse
(pesan)
ProjectConfigService
Konfigurasi project untuk Identity Toolkit
CreateDefaultSupportedIdpConfig |
---|
Buat konfigurasi IdP default yang didukung untuk project Identity Toolkit.
|
CreateInboundSamlConfig |
---|
Membuat konfigurasi SAML masuk untuk project Identity Toolkit.
|
CreateOAuthIdpConfig |
---|
Membuat konfigurasi IdP Oidc untuk project Identity Toolkit.
|
DeleteDefaultSupportedIdpConfig |
---|
Menghapus konfigurasi IdP default yang didukung untuk project Identity Toolkit.
|
DeleteInboundSamlConfig |
---|
Menghapus konfigurasi SAML masuk untuk project Identity Toolkit.
|
DeleteOAuthIdpConfig |
---|
Menghapus konfigurasi IdP Oidc untuk project Identity Toolkit.
|
EnableCicp |
---|
Mengaktifkan CICP untuk project Cloud. Cloud Identity for Customers and Partners (atau CICP) adalah sistem autentikasi menyeluruh bagi pengguna pihak ketiga untuk mengakses aplikasi dan layanan Anda. Hal ini dapat mencakup Aplikasi Seluler/Web, Game, API, dan lainnya.
|
GetConfig |
---|
Mengambil konfigurasi project Identity Toolkit.
|
GetDefaultSupportedIdpConfig |
---|
Mengambil konfigurasi IdP default yang didukung untuk project Identity Toolkit.
|
GetInboundSamlConfig |
---|
Mengambil konfigurasi SAML masuk untuk project Identity Toolkit.
|
GetOAuthIdpConfig |
---|
Mengambil konfigurasi IdP Oidc untuk project Identity Toolkit.
|
ListDefaultSupportedIdpConfigs |
---|
Mencantumkan semua konfigurasi IdP default yang didukung untuk project Identity Toolkit.
|
ListDefaultSupportedIdps |
---|
Mencantumkan semua IdP default yang didukung.
|
ListInboundSamlConfigs |
---|
Mencantumkan semua konfigurasi SAML masuk untuk project Identity Toolkit.
|
ListOAuthIdpConfigs |
---|
Mencantumkan semua konfigurasi Oidc Idp untuk project Identity Toolkit.
|
UpdateConfig |
---|
Mengupdate konfigurasi project Identity Toolkit.
|
UpdateDefaultSupportedIdpConfig |
---|
Mengupdate konfigurasi IdP default yang didukung untuk project Identity Toolkit.
|
UpdateInboundSamlConfig |
---|
Mengupdate konfigurasi SAML masuk untuk project Identity Toolkit.
|
UpdateOAuthIdpConfig |
---|
Mengupdate konfigurasi IdP Oidc untuk project Identity Toolkit.
|
VerifyDomain |
---|
Pastikan domain kustom yang diminta memiliki data DNS yang diperlukan.
|
TenantManagementService
Layanan pengelolaan tenant untuk GCIP.
CreateTenant |
---|
Buat tenant. Memerlukan izin tulis pada project Agen.
|
DeleteTenant |
---|
Menghapus tenant. Memerlukan izin tulis pada project Agen.
|
GetTenant |
---|
Mendapatkan tenant. Memerlukan izin baca pada resource Tenant.
|
ListTenants |
---|
Mencantumkan tenant dalam project agen tertentu. Memerlukan izin baca pada project Agen.
|
UpdateTenant |
---|
Memperbarui tenant. Memerlukan izin tulis pada resource Tenant.
|
BlockingFunctionsConfig
Konfigurasi yang terkait dengan fungsi pemblokiran.
Kolom | |
---|---|
triggers |
Peta Pemicu ke jenis peristiwa. Kunci harus berupa salah satu jenis peristiwa yang didukung: "beforeCreate", "beforeSignIn" |
Pemicu
Cloud Function Sinkron dengan Pemicu HTTP
Kolom | |
---|---|
function_uri |
Pemicu URI HTTP untuk Cloud Function. |
update_time |
Saat pemicu diubah. |
ClientConfig
Opsi terkait cara klien membuat permintaan atas nama project harus dikonfigurasi.
Kolom | |
---|---|
api_key |
Hanya output. Kunci API yang dapat digunakan saat membuat permintaan untuk project ini. |
permissions |
Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya. |
firebase_subdomain |
Hanya output. Subdomain Firebase. |
Izin
Konfigurasi terkait pembatasan kemampuan pengguna untuk memengaruhi akunnya.
Kolom | |
---|---|
disabled_user_signup |
Jika benar (true), pengguna akhir tidak dapat mendaftar ke akun baru di project terkait melalui metode API kami |
disabled_user_deletion |
Jika benar, pengguna akhir tidak dapat menghapus akun mereka di project terkait melalui metode API kami |
Konfigurasi
Merepresentasikan project Identity Toolkit.
Kolom | |
---|---|
name |
Hanya output. Nama resource Config. Contoh: "projects/my-awesome-project/config" |
sign_in |
Konfigurasi yang terkait dengan metode login lokal. |
notification |
Konfigurasi yang terkait dengan pengiriman notifikasi kepada pengguna. |
quota |
Konfigurasi yang terkait dengan kuota. |
monitoring |
Konfigurasi yang terkait dengan pemantauan aktivitas project. |
authorized_domains[] |
Daftar domain yang diotorisasi untuk pengalihan OAuth |
subtype |
Hanya output. Subjenis konfigurasi ini. |
client |
Opsi terkait cara klien membuat permintaan atas nama project harus dikonfigurasi. |
mfa |
Konfigurasi untuk autentikasi multi-faktor project ini, termasuk apakah autentikasi aktif dan faktor apa yang dapat digunakan untuk faktor kedua |
blocking_functions |
Konfigurasi yang terkait dengan fungsi pemblokiran. |
Subjenis
Subjenis konfigurasi ini.
Enum | |
---|---|
SUBTYPE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
CUSTOMER_IDENTITY |
Project Identitas Pelanggan. |
FIREBASE_AUTH |
Project Firebase Authentication. |
CreateDefaultSupportedIdpConfigRequest
Permintaan untuk CreateDefaultSupportedIdpConfig
Kolom | |
---|---|
parent |
Nama resource induk tempat konfigurasi akan dibuat, misalnya: "projects/my-awesome-project" Otorisasi memerlukan izin IAM berikut pada resource
|
idp_id |
ID IdP yang akan dibuat konfigurasinya. Panggil ListDefaultSupportedIdps untuk mendapatkan daftar semua IdP default yang didukung. |
default_supported_idp_config |
Resource konfigurasi yang menggantikan resource di server. |
CreateInboundSamlConfigRequest
Permintaan untuk CreateInboundSamlConfig
Kolom | |
---|---|
parent |
Nama resource induk tempat konfigurasi akan dibuat, misalnya: "projects/my-awesome-project" Otorisasi memerlukan izin IAM berikut pada resource
|
inbound_saml_config_id |
ID yang akan digunakan untuk konfigurasi ini. |
inbound_saml_config |
Resource konfigurasi yang akan dibuat. Klien tidak boleh menetapkan kolom |
CreateOAuthIdpConfigRequest
Permintaan untuk CreateOAuthIdpConfig
Kolom | |
---|---|
parent |
Nama resource induk tempat konfigurasi akan dibuat, misalnya: "projects/my-awesome-project" Otorisasi memerlukan izin IAM berikut pada resource
|
oauth_idp_config_id |
ID yang akan digunakan untuk konfigurasi ini. |
oauth_idp_config |
Resource konfigurasi yang akan dibuat. Klien tidak boleh menetapkan kolom |
CreateTenantRequest
Pesan permintaan untuk CreateTenant.
Kolom | |
---|---|
parent |
Nama resource induk tempat tenant akan dibuat. Misalnya, "projects/project1". Otorisasi memerlukan izin IAM berikut pada resource
|
tenant |
Wajib. Tenant yang akan dibuat. |
DefaultSupportedIdp
IDP tepercaya Identity Toolkit standar.
Kolom | |
---|---|
idp_id |
ID IdP |
description |
Deskripsi IdP |
DefaultSupportedIdpConfig
Opsi konfigurasi untuk mengautentikasi dengan kumpulan standar IDP tepercaya Identity Toolkit.
Kolom | |
---|---|
name |
Nama resource DefaultSupportedIdpConfig, misalnya: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" |
enabled |
Benar jika mengizinkan pengguna login dengan penyedia. |
client_id |
Client ID OAuth. |
client_secret |
Rahasia klien OAuth. |
display_on_cloud_console |
Hanya output. Menentukan apakah akan menampilkan konfigurasi IdP di Pantheon jika IdP dalam status nonaktif. |
DeleteDefaultSupportedIdpConfigRequest
Permintaan untuk DeleteDefaultSupportedIdpConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi, misalnya: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" Otorisasi memerlukan izin IAM berikut pada resource
|
DeleteInboundSamlConfigRequest
Permintaan untuk DeleteInboundSamlConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi yang akan dihapus, misalnya: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Otorisasi memerlukan izin IAM berikut pada resource
|
DeleteOAuthIdpConfigRequest
Permintaan untuk DeleteOAuthIdpConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi yang akan dihapus, misalnya: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Otorisasi memerlukan izin IAM berikut pada resource
|
DeleteTenantRequest
Pesan permintaan untuk DeleteTenant.
Kolom | |
---|---|
name |
Nama resource tenant yang akan dihapus. Otorisasi memerlukan izin IAM berikut pada resource
|
EnableCicpRequest
Permintaan untuk EnableCicp.
Kolom | |
---|---|
project |
Nama resource project target yang ingin diaktifkan CICP-nya oleh developer. Otorisasi memerlukan izin IAM berikut pada resource
|
EnableCicpResponse
Jenis ini tidak memiliki kolom.
Respons untuk EnableCicp. Kosong untuk saat ini.
GetConfigRequest
Permintaan untuk GetConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi, misalnya: "projects/my-awesome-project/config" Otorisasi memerlukan izin IAM berikut pada resource
|
GetDefaultSupportedIdpConfigRequest
Permintaan untuk GetDefaultSupportedIdpConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi, misalnya: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" Otorisasi memerlukan izin IAM berikut pada resource
|
GetInboundSamlConfigRequest
Permintaan untuk GetInboundSamlConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi, misalnya: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Otorisasi memerlukan izin IAM berikut pada resource
|
GetOAuthIdpConfigRequest
Permintaan untuk GetOAuthIdpConfig
Kolom | |
---|---|
name |
Nama resource konfigurasi, misalnya: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Otorisasi memerlukan izin IAM berikut pada resource
|
GetTenantRequest
Pesan permintaan untuk GetTenant.
Kolom | |
---|---|
name |
Nama resource tenant yang akan diambil. Otorisasi memerlukan izin IAM berikut pada resource
|
HashConfig
Informasi histori algoritma dan kunci hash. Sandi akun yang berbeda dapat dibuat oleh versi yang berbeda.
Kolom | |
---|---|
algorithm |
Hanya output. Berbagai algoritma hash sandi yang digunakan di Identity Toolkit. |
signer_key |
Hanya output. Kunci penanda tangan dalam base64. |
salt_separator |
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. |
memory_cost |
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 |
IdpCertificate
Proto untuk data sertifikat IdP guna memverifikasi tanda tangan di SAMLResponse yang dikeluarkan oleh IdP.
Kolom | |
---|---|
x509_certificate |
Sertifikat x509 |
InboundSamlConfig
Proto untuk menyimpan sepasang konfigurasi RP-IDP SAML saat project bertindak sebagai pihak tepercaya.
Kolom | |
---|---|
name |
Nama resource InboundSamlConfig, misalnya: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Diabaikan selama permintaan pembuatan. |
idp_config |
Proto untuk menyimpan konfigurasi IdP (Penyedia Identitas) SAML saat project bertindak sebagai pihak tepercaya. |
sp_config |
Proto untuk menyimpan konfigurasi SP (Penyedia Layanan) SAML saat project bertindak sebagai pihak tepercaya untuk menerima dan menyetujui pernyataan autentikasi yang dikeluarkan oleh penyedia identitas SAML. |
display_name |
Nama tampilan konfigurasi yang ditetapkan oleh developer. |
enabled |
Benar jika mengizinkan pengguna login dengan penyedia. |
IdpConfig
Proto untuk menyimpan konfigurasi IdP (Penyedia Identitas) SAML saat project bertindak sebagai pihak tepercaya.
Kolom | |
---|---|
idp_entity_id |
ID unik untuk semua entitas SAML. |
sso_url |
URL tujuan pengiriman permintaan Authentication. |
idp_certificates[] |
Kunci publik IdP untuk memverifikasi tanda tangan dalam pernyataan. |
sign_request |
Menunjukkan apakah SAMLRequest keluar harus ditandatangani. |
SpConfig
Proto untuk menyimpan konfigurasi SP (Penyedia Layanan) SAML saat project bertindak sebagai pihak tepercaya untuk menerima dan menyetujui pernyataan autentikasi yang dikeluarkan oleh penyedia identitas SAML.
Kolom | |
---|---|
sp_entity_id |
ID unik untuk semua entitas SAML. |
callback_uri |
URI callback tempat respons dari IdP ditangani. |
sp_certificates[] |
Hanya output. Sertifikat publik yang dihasilkan oleh server untuk memverifikasi tanda tangan di SAMLRequest dalam alur yang dimulai dengan SP. |
ListDefaultSupportedIdpConfigsRequest
Permintaan untuk ListDefaultSupportedIdpConfigs
Kolom | |
---|---|
parent |
Nama resource induk, misalnya, "projects/my-awesome-project". Otorisasi memerlukan izin IAM berikut pada resource
|
page_size |
Jumlah maksimum item untuk ditampilkan. |
page_token |
Nilai next_page_token yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. |
ListDefaultSupportedIdpConfigsResponse
Respons untuk ListDefaultSupportedIdpConfigs
Kolom | |
---|---|
default_supported_idp_configs[] |
Kumpulan konfigurasi. |
next_page_token |
Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar. |
ListDefaultSupportedIdpsRequest
Permintaan untuk ListDefaultSupportedIdps
Kolom | |
---|---|
page_size |
Jumlah maksimum item untuk ditampilkan. |
page_token |
Nilai next_page_token yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. |
ListDefaultSupportedIdpsResponse
Respons untuk ListDefaultSupportedIdps
Kolom | |
---|---|
default_supported_idps[] |
Kumpulan konfigurasi. |
next_page_token |
Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar. |
ListInboundSamlConfigsRequest
Permintaan untuk ListInboundSamlConfigs
Kolom | |
---|---|
parent |
Nama resource induk, misalnya, "projects/my-awesome-project". Otorisasi memerlukan izin IAM berikut pada resource
|
page_size |
Jumlah maksimum item untuk ditampilkan. |
page_token |
Nilai next_page_token yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. |
ListInboundSamlConfigsResponse
Respons untuk ListInboundSamlConfigs
Kolom | |
---|---|
inbound_saml_configs[] |
Kumpulan konfigurasi. |
next_page_token |
Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar. |
ListOAuthIdpConfigsRequest
Permintaan untuk ListOAuthIdpConfigs
Kolom | |
---|---|
parent |
Nama resource induk, misalnya, "projects/my-awesome-project". Otorisasi memerlukan izin IAM berikut pada resource
|
page_size |
Jumlah maksimum item untuk ditampilkan. |
page_token |
Nilai next_page_token yang ditampilkan dari permintaan Daftar sebelumnya, jika ada. |
ListOAuthIdpConfigsResponse
Respons untuk ListOAuthIdpConfigs
Kolom | |
---|---|
oauth_idp_configs[] |
Kumpulan konfigurasi. |
next_page_token |
Token untuk mengambil halaman hasil berikutnya, atau kosong jika tidak ada lagi hasil dalam daftar. |
ListTenantsRequest
Pesan permintaan untuk ListTenants.
Kolom | |
---|---|
parent |
Wajib. Nama resource induk untuk mencantumkan tenant. Otorisasi memerlukan izin IAM berikut pada resource
|
page_token |
Token penomoran halaman dari respons permintaan sebelumnya. |
page_size |
Jumlah maksimum hasil yang akan ditampilkan, dibatasi hingga 1.000. Jika tidak ditentukan, nilai defaultnya adalah 20. |
ListTenantsResponse
Pesan respons untuk ListTenants.
Kolom | |
---|---|
tenants[] |
Daftar tenant dalam project agen tertentu. |
next_page_token |
Token untuk mendapatkan halaman hasil berikutnya. |
MonitoringConfig
Konfigurasi yang terkait dengan pemantauan aktivitas project.
Kolom | |
---|---|
request_logging |
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
Kolom | |
---|---|
enabled |
Apakah logging diaktifkan untuk project ini atau tidak. |
MultiFactorAuthConfig
Opsi yang terkait dengan Autentikasi Multi-Faktor untuk project.
Kolom | |
---|---|
state |
Apakah Autentikasi Multi-Faktor telah diaktifkan untuk project ini. |
enabled_providers[] |
Daftar faktor kedua yang dapat digunakan untuk project ini. |
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. |
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 |
ADMIN_ENABLED |
Autentikasi multi-faktor dapat digunakan untuk project ini, tetapi hanya dapat disiapkan oleh administrator project |
NotificationConfig
Konfigurasi yang terkait dengan pengiriman notifikasi kepada pengguna.
Kolom | |
---|---|
send_email |
Opsi untuk pengiriman email. |
send_sms |
Opsi untuk pengiriman SMS. |
default_locale |
Lokalitas default yang digunakan untuk email dan SMS dalam format IETF BCP 47. |
SendEmail
Opsi untuk pengiriman email.
Kolom | |
---|---|
method |
Metode yang digunakan untuk mengirim email. |
reset_password_template |
Template email untuk reset sandi |
verify_email_template |
Template email untuk memverifikasi email |
change_email_template |
Template email untuk email perubahan |
legacy_reset_password_template |
Template email reset sandi untuk aplikasi Firebase V1 lama. |
callback_uri |
URL tindakan dalam template email. |
dns_info |
Informasi verifikasi DNS domain kustom. |
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 |
Menggunakan relai SMTP kustom |
DnsInfo
Informasi verifikasi DNS domain kustom. Secara default, default_domain akan digunakan. Domain kustom dapat dikonfigurasi menggunakan VerifyCustomDomain.
Kolom | |
---|---|
custom_domain |
Hanya output. Domain kustom terverifikasi yang diterapkan. |
use_custom_domain |
Apakah akan menggunakan domain kustom. |
pending_custom_domain |
Hanya output. Domain kustom yang akan diverifikasi. |
custom_domain_state |
Hanya output. Status verifikasi domain kustom saat ini. Domain kustom hanya akan digunakan setelah verifikasi domain berhasil. |
domain_verification_request_time |
Hanya output. Stempel waktu permintaan awal untuk verifikasi domain saat ini. |
VerificationState
Status verifikasi domain kustom saat ini.
Enum | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
NOT_STARTED |
Verifikasi belum dimulai. |
IN_PROGRESS |
Verifikasi sedang berlangsung. |
FAILED |
Verifikasi gagal. |
SUCCEEDED |
Verifikasi berhasil dan siap diterapkan. |
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.
Kolom | |
---|---|
sender_local_part |
Bagian lokal dari alamat Pengirim |
subject |
Subjek email |
sender_display_name |
Nama tampilan pengirim |
body |
Isi email |
body_format |
Format isi email |
reply_to |
Alamat balas-ke |
customized |
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 |
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
Kolom | |
---|---|
sender_email |
Email pengirim untuk relai SMTP |
host |
Host relai SMTP |
port |
Port relai SMTP |
username |
Nama pengguna relai SMTP |
password |
Sandi relai SMTP |
security_mode |
Mode keamanan SMTP. |
SecurityMode
Mode keamanan SMTP.
Enum | |
---|---|
SECURITY_MODE_UNSPECIFIED |
Nilai default. Jangan gunakan. |
SSL |
Mode SSL |
START_TLS |
Mode START_TLS |
SendSms
Opsi untuk pengiriman SMS.
Kolom | |
---|---|
use_device_locale |
Apakah akan menggunakan header accept_language untuk SMS. |
sms_template |
Hanya output. Template yang akan digunakan saat mengirim SMS. |
SmsTemplate
Template yang akan digunakan saat mengirim SMS.
Kolom | |
---|---|
content |
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. |
OAuthIdpConfig
Opsi konfigurasi untuk mengautentikasi dengan IdP OAuth.
Kolom | |
---|---|
name |
Nama resource OAuthIdpConfig, misalnya: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Diabaikan selama permintaan pembuatan. |
client_id |
Client ID klien OAuth. |
issuer |
Untuk IdP OIDC, ID penerbit. |
display_name |
Nama tampilan konfigurasi yang ditetapkan oleh developer. |
enabled |
Benar jika mengizinkan pengguna login dengan penyedia. |
client_secret |
Rahasia klien klien OAuth, untuk mengaktifkan alur kode OIDC. |
response_type |
Jenis respons yang akan diminta dalam alur otorisasi OAuth. Anda dapat menetapkan |
OAuthResponseType
Jenis respons yang akan diminta dalam alur otorisasi OAuth. Anda dapat menetapkan id_token
atau code
ke benar, tetapi tidak keduanya. Menetapkan kedua jenis tersebut agar benar secara bersamaan ({code: true, id_token: true}
) belum didukung.
Lihat https://openid.net/specs/openid-connect-core-1_0.html#Authentication untuk pemetaan jenis respons ke alur OAuth 2.0.
Kolom | |
---|---|
id_token |
Jika benar, token ID akan ditampilkan dari endpoint otorisasi IdP. |
code |
Jika benar, kode otorisasi akan ditampilkan dari endpoint otorisasi IdP. |
token |
Jangan gunakan. Jenis respons |
QuotaConfig
Konfigurasi yang terkait dengan kuota.
Kolom | |
---|---|
sign_up_quota_config |
Kuota untuk endpoint Pendaftaran, jika ditimpa. Kuota pendaftaran diukur dalam pendaftaran per project per jam per IP. |
TemporaryQuota
Kenaikan / penurunan kuota sementara
Kolom | |
---|---|
quota |
Sesuai dengan kolom 'refill_token_count' di konfigurasi QuotaServer |
start_time |
Kapan kuota ini akan berlaku |
quota_duration |
Durasi aktif kuota ini |
SignInConfig
Konfigurasi yang terkait dengan metode login lokal.
Kolom | |
---|---|
email |
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan alamat emailnya. |
phone_number |
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan nomor telepon mereka. |
anonymous |
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna anonim. |
allow_duplicate_emails |
Apakah akan mengizinkan lebih dari satu akun memiliki email yang sama. |
hash_config |
Hanya output. Informasi konfigurasi hash. |
Anonim
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna anonim.
Kolom | |
---|---|
enabled |
Apakah autentikasi pengguna anonim diaktifkan untuk project atau tidak. |
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan alamat emailnya.
Kolom | |
---|---|
enabled |
Apakah autentikasi email diaktifkan untuk project atau tidak. |
password_required |
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. |
hash_config |
Hanya output. Informasi konfigurasi hash. |
PhoneNumber
Opsi konfigurasi yang terkait dengan mengautentikasi pengguna berdasarkan nomor telepon mereka.
Kolom | |
---|---|
enabled |
Apakah autentikasi nomor telepon diaktifkan untuk project atau tidak. |
test_phone_numbers |
Peta <nomor telepon pengujian, kode palsu> yang dapat digunakan untuk pengujian autentikasi telepon. |
SpCertificate
Proto untuk data sertifikat SP bagi IDP untuk memverifikasi SAMLRequest yang dihasilkan oleh SP.
Kolom | |
---|---|
x509_certificate |
Sertifikat publik yang ditandatangani sendiri. |
expires_at |
Stempel waktu instance habis masa berlaku sertifikat. |
Tenant
Tenant berisi konfigurasi untuk tenant dalam project multi-tenant.
Kolom | |
---|---|
name |
Nama resource tenant. Misalnya: "projects/project1/tenants/tenant1" |
display_name |
Nama tampilan tenant. |
saml_configs[] |
Konfigurasi SAML diminta. |
idp_configs[] |
Konfigurasi IdP diminta. |
allow_password_signup |
Apakah akan mengizinkan pendaftaran dengan email/sandi. |
enable_email_link_signin |
Apakah akan mengaktifkan pendaftaran dengan link email. |
disable_auth |
Apakah tenant dinonaktifkan untuk autentikasi. Pengguna di tenant yang dinonaktifkan tidak diizinkan untuk login. Admin tenant yang dinonaktifkan tidak dapat mengelola penggunanya. |
UpdateConfigRequest
Permintaan untuk UpdateConfig
Kolom | |
---|---|
config |
Resource konfigurasi yang menggantikan resource di server. Otorisasi memerlukan izin IAM berikut pada resource
|
update_mask |
Mask update berlaku untuk resource. Kolom yang ditetapkan dalam konfigurasi, tetapi tidak disertakan dalam mask pembaruan ini akan diabaikan. Untuk definisi |
UpdateDefaultSupportedIdpConfigRequest
Permintaan untuk UpdateDefaultSupportedIdpConfig
Kolom | |
---|---|
default_supported_idp_config |
Resource konfigurasi yang menggantikan resource di server. Otorisasi memerlukan izin IAM berikut pada resource
|
update_mask |
Mask update berlaku untuk resource. Untuk definisi |
UpdateInboundSamlConfigRequest
Permintaan untuk UpdateInboundSamlConfig
Kolom | |
---|---|
inbound_saml_config |
Resource konfigurasi yang menggantikan resource di server. Otorisasi memerlukan izin IAM berikut pada resource
|
update_mask |
Mask update berlaku untuk resource. Mask pembaruan kosong tidak akan memperbarui apa pun. Untuk definisi |
UpdateOAuthIdpConfigRequest
Permintaan untuk UpdateOAuthIdpConfig
Kolom | |
---|---|
oauth_idp_config |
Resource konfigurasi yang menggantikan resource di server. Otorisasi memerlukan izin IAM berikut pada resource
|
update_mask |
Mask update berlaku untuk resource. Mask pembaruan kosong tidak akan memperbarui apa pun. Untuk definisi |
UpdateTenantRequest
Pesan permintaan untuk UpdateTenant.
Kolom | |
---|---|
tenant |
Wajib. Tenant yang akan diperbarui. Otorisasi memerlukan izin IAM berikut pada resource
|
update_mask |
Mask update berlaku untuk resource. Untuk definisi |
VerifyDomainRequest
Pesan permintaan untuk memverifikasi bahwa domain kustom yang diminta memiliki data DNS yang diperlukan.
Kolom | |
---|---|
resource |
Nama resource yang akan diverifikasi domainnya. Metode ini saat ini menerima verifikasi domain untuk project (contoh 'projects/my-awesome-project') atau tenant (contoh 'projects/my-awesome-project/tenants/my-awesome-tenant'). Otorisasi memerlukan izin IAM berikut pada resource
|
domain |
Domain target permintaan ini. |
action |
Tindakan yang dicoba di domain tertentu. |
DomainVerificationAction
Tindakan yang dicoba di domain tertentu.
Enum | |
---|---|
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED |
Nilai default. Jangan gunakan. |
VERIFY |
Verifikasi domain dalam permintaan. |
CANCEL |
Membatalkan proses verifikasi saat ini. |
APPLY |
Terapkan domain kustom dalam pengiriman email. |
VerifyDomainResponse
Respons untuk permintaan VerifyDomain.
Kolom | |
---|---|
verification_state |
Status yang dihasilkan untuk domain tertentu setelah permintaan ini diproses. |
verification_error |
Jika berlaku, penjelasan teks tentang alasan domain tidak dapat diverifikasi. |