Identity Toolkit API

Google Identity Toolkit API memungkinkan Anda menggunakan standar terbuka untuk memverifikasi identitas pengguna.

Layanan: identitytoolkit.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat Anda membuat permintaan API.

Dokumen Discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen penemuan berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah bersifat relatif dengan endpoint layanan ini:

  • https://identitytoolkit.googleapis.com

REST Resource: v2

Metode
getPasswordPolicy GET /v2/passwordPolicy
Mendapatkan konfigurasi kebijakan sandi yang ditetapkan di project atau tenant.
getRecaptchaConfig GET /v2/recaptchaConfig
Mendapatkan parameter yang diperlukan untuk analisis reCAPTCHA.

REST Resource: v2.accounts

Metode
revokeToken POST /v2/accounts:revokeToken
Membatalkan token pengguna dari Penyedia Identitas (IdP).

REST Resource: v2.accounts.mfaEnrollment

Metode
finalize POST /v2/accounts/mfaEnrollment:finalize
Menyelesaikan pendaftaran faktor kedua untuk pengguna.
start POST /v2/accounts/mfaEnrollment:start
Langkah pertama proses pendaftaran MFA.
withdraw POST /v2/accounts/mfaEnrollment:withdraw
Membatalkan satu faktor kedua dari faktor kedua yang terdaftar untuk akun.

REST Resource: v2.accounts.mfaSignIn

Metode
finalize POST /v2/accounts/mfaSignIn:finalize
Memverifikasi verifikasi login multi-faktor dan melakukan login
start POST /v2/accounts/mfaSignIn:start
Mengirim verifikasi login multi-faktor

Resource REST: v2.defaultSupportedIdps

Metode
list GET /admin/v2/defaultSupportedIdps
Mencantumkan semua IdP default yang didukung.

Resource REST: v2.projects

Metode
getConfig GET /admin/v2/{name=projects/*/config}
Mengambil konfigurasi project Identity Toolkit.
updateConfig PATCH /admin/v2/{config.name=projects/*/config}
Mengupdate konfigurasi project Identity Toolkit.

Resource REST: v2.projects.defaultSupportedIdpConfigs

Metode
create POST /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Membuat konfigurasi IdP default yang didukung untuk project Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Menghapus konfigurasi IdP default yang didukung untuk project Identity Toolkit.
get GET /admin/v2/{name=projects/*/defaultSupportedIdpConfigs/*}
Mengambil konfigurasi IdP default yang didukung untuk project Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/defaultSupportedIdpConfigs
Mencantumkan semua konfigurasi IdP default yang didukung untuk project Identity Toolkit.
patch PATCH /admin/v2/{defaultSupportedIdpConfig.name=projects/*/defaultSupportedIdpConfigs/*}
Mengupdate konfigurasi IdP default yang didukung untuk project Identity Toolkit.

Resource REST: v2.projects.domain

Metode
verify POST /admin/v2/{resource=projects/*}/domain:verify
Pastikan domain kustom yang diminta memiliki data DNS yang diperlukan.

Resource REST: v2.projects.identityPlatform

Metode
initializeAuth POST /v2/{project=projects/*}/identityPlatform:initializeAuth
Lakukan inisialisasi Identity Platform untuk project Cloud.

Resource REST: v2.projects.inboundSamlConfigs

Metode
create POST /admin/v2/{parent=projects/*}/inboundSamlConfigs
Membuat konfigurasi SAML masuk untuk project Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Menghapus konfigurasi SAML masuk untuk project Identity Toolkit.
get GET /admin/v2/{name=projects/*/inboundSamlConfigs/*}
Mengambil konfigurasi SAML masuk untuk project Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/inboundSamlConfigs
Mencantumkan semua konfigurasi SAML masuk untuk project Identity Toolkit.
patch PATCH /admin/v2/{inboundSamlConfig.name=projects/*/inboundSamlConfigs/*}
Mengupdate konfigurasi SAML masuk untuk project Identity Toolkit.

Resource REST: v2.projects.oauthIdpConfigs

Metode
create POST /admin/v2/{parent=projects/*}/oauthIdpConfigs
Membuat konfigurasi IdP Oidc untuk project Identity Toolkit.
delete DELETE /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Menghapus konfigurasi IdP Oidc untuk project Identity Toolkit.
get GET /admin/v2/{name=projects/*/oauthIdpConfigs/*}
Mengambil konfigurasi IdP Oidc untuk project Identity Toolkit.
list GET /admin/v2/{parent=projects/*}/oauthIdpConfigs
Mencantumkan semua konfigurasi Oidc Idp untuk project Identity Toolkit.
patch PATCH /admin/v2/{oauthIdpConfig.name=projects/*/oauthIdpConfigs/*}
Mengupdate konfigurasi IdP Oidc untuk project Identity Toolkit.

Resource REST: v2.projects.tenants

Metode
create POST /v2/{parent=projects/*}/tenants
Buat tenant.
delete DELETE /v2/{name=projects/*/tenants/*}
Menghapus tenant.
get GET /v2/{name=projects/*/tenants/*}
Mendapatkan tenant.
getIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:getIamPolicy
Mendapatkan kebijakan kontrol akses untuk resource.
list GET /v2/{parent=projects/*}/tenants
Mencantumkan tenant dalam project agen tertentu.
patch PATCH /v2/{tenant.name=projects/*/tenants/*}
Memperbarui tenant.
setIamPolicy POST /admin/v2/{resource=projects/*/tenants/*}:setIamPolicy
Menetapkan kebijakan kontrol akses untuk resource.
testIamPermissions POST /admin/v2/{resource=projects/*/tenants/*}:testIamPermissions
Menampilkan izin pemanggil pada resource.

Resource REST: v2.projects.tenants.defaultSupportedIdpConfigs

Metode
create POST /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Membuat konfigurasi IdP default yang didukung untuk project Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Menghapus konfigurasi IdP default yang didukung untuk project Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Mengambil konfigurasi IdP default yang didukung untuk project Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/defaultSupportedIdpConfigs
Mencantumkan semua konfigurasi IdP default yang didukung untuk project Identity Toolkit.
patch PATCH /v2/{defaultSupportedIdpConfig.name=projects/*/tenants/*/defaultSupportedIdpConfigs/*}
Mengupdate konfigurasi IdP default yang didukung untuk project Identity Toolkit.

Resource REST: v2.projects.tenants.domain

Metode
verify POST /admin/v2/{resource=projects/*/tenants/*}/domain:verify
Pastikan domain kustom yang diminta memiliki data DNS yang diperlukan.

Resource REST: v2.projects.tenants.inboundSamlConfigs

Metode
create POST /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Membuat konfigurasi SAML masuk untuk project Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Menghapus konfigurasi SAML masuk untuk project Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/inboundSamlConfigs/*}
Mengambil konfigurasi SAML masuk untuk project Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/inboundSamlConfigs
Mencantumkan semua konfigurasi SAML masuk untuk project Identity Toolkit.
patch PATCH /v2/{inboundSamlConfig.name=projects/*/tenants/*/inboundSamlConfigs/*}
Mengupdate konfigurasi SAML masuk untuk project Identity Toolkit.

Resource REST: v2.projects.tenants.oauthIdpConfigs

Metode
create POST /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Membuat konfigurasi IdP Oidc untuk project Identity Toolkit.
delete DELETE /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Menghapus konfigurasi IdP Oidc untuk project Identity Toolkit.
get GET /v2/{name=projects/*/tenants/*/oauthIdpConfigs/*}
Mengambil konfigurasi IdP Oidc untuk project Identity Toolkit.
list GET /v2/{parent=projects/*/tenants/*}/oauthIdpConfigs
Mencantumkan semua konfigurasi Oidc Idp untuk project Identity Toolkit.
patch PATCH /v2/{oauthIdpConfig.name=projects/*/tenants/*/oauthIdpConfigs/*}
Mengupdate konfigurasi IdP Oidc untuk project Identity Toolkit.

Resource REST: v1

Metode
getProjects GET /v1/projects
Mendapatkan konfigurasi Identity Toolkit publik project.
getPublicKeys GET /v1/publicKeys
Mengambil kunci publik penanda tangan token Identity Toolkit lama untuk memungkinkan pihak ketiga memverifikasi token ID lama.
getRecaptchaParams GET /v1/recaptchaParams
Mendapatkan parameter yang diperlukan untuk membuat tantangan reCAPTCHA.
getSessionCookiePublicKeys GET /v1/sessionCookiePublicKeys
Mengambil kumpulan kunci publik penanda tangan Token Web JSON (JWT) cookie sesi yang dapat digunakan untuk memvalidasi cookie sesi yang dibuat melalui createSessionCookie.

Resource REST: v1.accounts

Metode
createAuthUri POST /v1/accounts:createAuthUri
Jika ID email ditentukan, periksa dan tampilkan apakah ada akun pengguna yang terdaftar dengan email tersebut.
delete POST /v1/accounts:delete
Menghapus akun pengguna.
issueSamlResponse POST /v1/accounts:issueSamlResponse
Eksperimental
lookup POST /v1/accounts:lookup
Mendapatkan informasi akun untuk semua akun yang cocok.
resetPassword POST /v1/accounts:resetPassword
Mereset sandi akun menggunakan kode out-of-band yang dihasilkan oleh sendOobCode atau dengan menentukan email dan sandi akun yang akan diubah.
sendOobCode POST /v1/accounts:sendOobCode
Mengirim kode konfirmasi di luar band untuk akun.
sendVerificationCode POST /v1/accounts:sendVerificationCode
Mengirim kode verifikasi SMS untuk login dengan nomor telepon.
signInWithCustomToken POST /v1/accounts:signInWithCustomToken
Memproses login atau pendaftaran pengguna dengan menukarkan token Auth kustom.
signInWithEmailLink POST /v1/accounts:signInWithEmailLink
Login atau mendaftarkan pengguna dengan kode out-of-band dari link email.
signInWithGameCenter POST /v1/accounts:signInWithGameCenter
Memproses login atau pendaftaran pengguna dengan kredensial Game Center iOS.
signInWithIdp POST /v1/accounts:signInWithIdp
Login atau mendaftarkan pengguna menggunakan kredensial dari Penyedia Identitas (IdP).
signInWithPassword POST /v1/accounts:signInWithPassword
Memproses login pengguna dengan email dan sandi.
signInWithPhoneNumber POST /v1/accounts:signInWithPhoneNumber
Menyelesaikan upaya autentikasi nomor telepon.
signUp POST /v1/accounts:signUp
Mendaftarkan pengguna email dan sandi baru atau pengguna anonim, atau mengupgrade pengguna anonim ke email dan sandi.
update POST /v1/accounts:update
Memperbarui informasi terkait akun untuk pengguna yang ditentukan dengan menetapkan kolom tertentu atau menerapkan kode tindakan.
verifyIosClient POST /v1/accounts:verifyIosClient
Memverifikasi bahwa klien iOS adalah perangkat iOS sungguhan.

Resource REST: v1.projects

Metode
accounts POST /v1/projects/{targetProjectId}/accounts
Mendaftarkan pengguna email dan sandi baru atau pengguna anonim, atau mengupgrade pengguna anonim ke email dan sandi.
createSessionCookie POST /v1/projects/{targetProjectId}:createSessionCookie
Membuat cookie sesi untuk token ID Identity Platform yang diberikan.
queryAccounts POST /v1/projects/{targetProjectId}:queryAccounts
Mencari akun pengguna dalam project atau tenant berdasarkan kondisi dalam permintaan.

Resource REST: v1.projects.accounts

Metode
batchCreate POST /v1/projects/{targetProjectId}/accounts:batchCreate
Mengupload beberapa akun ke project Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/accounts:batchDelete
Menghapus beberapa akun secara massal.
batchGet GET /v1/projects/{targetProjectId}/accounts:batchGet
Mendownload informasi akun untuk semua akun di project secara berpagi.
delete POST /v1/projects/{targetProjectId}/accounts:delete
Menghapus akun pengguna.
lookup POST /v1/projects/{targetProjectId}/accounts:lookup
Mendapatkan informasi akun untuk semua akun yang cocok.
query POST /v1/projects/{targetProjectId}/accounts:query
Mencari akun pengguna dalam project atau tenant berdasarkan kondisi dalam permintaan.
sendOobCode POST /v1/projects/{targetProjectId}/accounts:sendOobCode
Mengirim kode konfirmasi di luar band untuk akun.
update POST /v1/projects/{targetProjectId}/accounts:update
Memperbarui informasi terkait akun untuk pengguna yang ditentukan dengan menetapkan kolom tertentu atau menerapkan kode tindakan.

Resource REST: v1.projects.tenants

Metode
accounts POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
Mendaftarkan pengguna email dan sandi baru atau pengguna anonim, atau mengupgrade pengguna anonim ke email dan sandi.
createSessionCookie POST /v1/projects/{targetProjectId}/tenants/{tenantId}:createSessionCookie
Membuat cookie sesi untuk token ID Identity Platform yang diberikan.

Resource REST: v1.projects.tenants.accounts

Metode
batchCreate POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchCreate
Mengupload beberapa akun ke project Google Cloud.
batchDelete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete
Menghapus beberapa akun secara massal.
batchGet GET /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchGet
Mendownload informasi akun untuk semua akun di project secara berpagi.
delete POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:delete
Menghapus akun pengguna.
lookup POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:lookup
Mendapatkan informasi akun untuk semua akun yang cocok.
query POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:query
Mencari akun pengguna dalam project atau tenant berdasarkan kondisi dalam permintaan.
sendOobCode POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:sendOobCode
Mengirim kode konfirmasi di luar band untuk akun.
update POST /v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update
Memperbarui informasi terkait akun untuk pengguna yang ditentukan dengan menetapkan kolom tertentu atau menerapkan kode tindakan.