Method: getProjects

Mendapatkan konfigurasi Identity Toolkit publik project. (Lama) Metode ini juga mendukung panggilan yang diautentikasi dari developer untuk mengambil konfigurasi non-publik.

Permintaan HTTP

GET https://identitytoolkit.googleapis.com/v1/projects

URL menggunakan sintaks gRPC Transcoding.

Parameter kueri

Parameter
delegatedProjectNumber

string (int64 format)

Nomor Project permintaan project yang didelegasikan. Kolom ini hanya boleh digunakan sebagai bagian dari migrasi Firebase V1.
projectNumber

string (int64 format)

Nomor project konfigurasi yang akan diambil. Kolom ini tidak digunakan lagi dan tidak boleh digunakan oleh integrasi baru.
androidPackageName

string

Nama paket Android untuk diperiksa dengan nama paket Android yang sebenarnya. Jika kolom ini diberikan, dan sha1_cert_hash tidak diberikan, tindakan akan menampilkan error jika tidak cocok dengan nama paket Android yang sebenarnya.
iosBundleId

string

ID paket iOS untuk diperiksa dengan ID paket iOS yang sebenarnya. Jika kolom ini disediakan, tindakan akan menampilkan error jika tidak cocok dengan ID paket iOS yang sebenarnya.
clientId

string

Client ID OAuth RP. Jika ditetapkan, pemeriksaan akan dilakukan untuk memastikan bahwa klien OAuth valid untuk project yang diambil dan permintaan ditolak dengan error klien jika tidak valid.
sha1Cert

string

Hash sertifikat aplikasi Android SHA-1. Jika ditetapkan, pemeriksaan akan dilakukan untuk memastikan bahwa hash sertifikat valid untuk project dan androidPackageName yang diambil.
firebaseAppId

string

ID aplikasi Firebase, untuk aplikasi yang menggunakan Firebase. Ini dapat ditemukan di Firebase console untuk project Anda. Jika ditetapkan, pemeriksaan akan dilakukan untuk memastikan bahwa ID aplikasi valid untuk project yang diambil. Jika tidak valid, permintaan akan ditolak dengan error klien.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk v1.getProjects.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "projectId": string,
  "apiKey": string,
  "allowPasswordUser": boolean,
  "idpConfig": [
    {
      object (IdpConfig)
    }
  ],
  "authorizedDomains": [
    string
  ],
  "enableAnonymousUser": boolean,
  "dynamicLinksDomain": string,
  "useEmailSending": boolean,
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  }
}
Kolom
projectId

string

Project ID konfigurasi yang diambil.
apiKey

string

Kunci Google Cloud API. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
allowPasswordUser

boolean

Apakah akan mengizinkan pendaftaran akun sandi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
idpConfig[]

object (IdpConfig)

Konfigurasi penyedia OAuth2. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
authorizedDomains[]

string

Domain yang diizinkan untuk pengalihan widget.
enableAnonymousUser

boolean

Apakah pengguna anonim diaktifkan. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
useEmailSending

boolean

Apakah akan menggunakan pengiriman email. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
resetPasswordTemplate

object (EmailTemplate)

Template email untuk mereset sandi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
verifyEmailTemplate

object (EmailTemplate)

Template email untuk email verifikasi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
changeEmailTemplate

object (EmailTemplate)

Template email untuk email perubahan. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.
legacyResetPasswordTemplate

object (EmailTemplate)

Template email reset sandi untuk aplikasi Firebase V1 lama. Kolom ini hanya ditampilkan untuk panggilan yang diautentikasi dari developer.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Template email untuk mengembalikan penambahan faktor kedua. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

IdpConfig

Konfigurasi penyedia identitas.

Representasi JSON 
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
Kolom
provider

enum (Provider)
enabled

boolean

Benar jika mengizinkan pengguna login dengan penyedia.
experimentPercent

integer

Persentase pengguna yang akan diminta/dialihkan ke login gabungan untuk IdP ini
clientId

string

Client ID OAuth2.
secret

string

Rahasia klien OAuth2.
whitelistedAudiences[]

string

Client ID yang diizinkan untuk pemeriksaan audiens.

Penyedia

Nama penyedia identitas.

Enum
PROVIDER_UNSPECIFIED
MSLIVE Microsoft Live sebagai penyedia identitas.
GOOGLE Google sebagai penyedia identitas.
FACEBOOK Facebook sebagai penyedia identitas.
PAYPAL PayPal sebagai penyedia identitas.
TWITTER Twitter sebagai penyedia identitas.
YAHOO Yahoo sebagai penyedia identitas.
AOL AOL sebagai penyedia identitas.
GITHUB GitHub sebagai penyedia identitas.
GOOGLE_PLAY_GAMES Google Play Game sebagai penyedia identitas.
LINKEDIN LinkedIn sebagai penyedia identitas.
IOS_GAME_CENTER iOS Game Center sebagai penyedia identitas.

EmailTemplate

Template email

Representasi JSON 
{
  "disabled": boolean,
  "from": string,
  "body": string,
  "subject": string,
  "fromDisplayName": string,
  "format": enum (EmailBodyFormat),
  "replyTo": string,
  "fromLocalPart": string,
  "locale": string,
  "customized": boolean
}
Kolom
disabled

boolean

Apakah template dinonaktifkan. Jika benar, template default akan digunakan.
from

string

Alamat pengirim email
body

string

Isi email
subject

string

Subjek email
fromDisplayName

string

Dari nama tampilan
format

enum (EmailBodyFormat)

Format isi email
replyTo

string

Alamat balas-ke
fromLocalPart

string

Bagian lokal dari alamat Pengirim
locale

string

Nilai dalam format kode bahasa III (misalnya, "zh-CN", "es"). Pemisah '-' dan '_' diterima.
customized

boolean

Apakah isi atau subjek email disesuaikan.

EmailBodyFormat

Format isi email

Enum
EMAIL_BODY_FORMAT_UNSPECIFIED Nilai default. Jangan gunakan.
PLAINTEXT Isi email dalam format teks biasa.
HTML Isi email dalam format HTML.