Indeks
AccountManagementService(grafis)AuthenticationService(grafis)ProjectConfigService(grafis)SessionManagementService(grafis)Argon2Parameters(pesan)Argon2Parameters.HashType(enum)Argon2Parameters.Version(enum)BatchDeleteAccountsRequest(pesan)BatchDeleteAccountsResponse(pesan)BatchDeleteAccountsResponse.BatchDeleteErrorInfo(pesan)ClientType(enum)CreateAuthUriRequest(pesan)CreateAuthUriResponse(pesan)CreateSessionCookieRequest(pesan)CreateSessionCookieResponse(pesan)DeleteAccountRequest(pesan)DeleteAccountResponse(pesan)DownloadAccountRequest(pesan)DownloadAccountResponse(pesan)EmailInfo(pesan)EmailTemplate(pesan)EmailTemplate.EmailBodyFormat(enum)ErrorInfo(pesan)GetAccountInfoRequest(pesan)GetAccountInfoRequest.FederatedUserIdentifier(pesan)GetAccountInfoResponse(pesan)GetOobCodeRequest(pesan)GetOobCodeResponse(pesan)GetProjectConfigRequest(pesan)GetProjectConfigResponse(pesan)GetRecaptchaParamResponse(pesan)GetSessionCookiePublicKeysResponse(pesan)IdpConfig(pesan)IdpConfig.Provider(enum)IssueSamlResponseRequest(pesan)IssueSamlResponseResponse(pesan)MfaEnrollment(pesan)OobReqType(enum)OpenIdConnectKey(pesan)ProviderUserInfo(pesan)QueryUserInfoRequest(pesan)QueryUserInfoRequest.Order(enum)QueryUserInfoRequest.SortByField(enum)QueryUserInfoRequest.SqlExpression(pesan)QueryUserInfoResponse(pesan)RecaptchaVersion(enum)ResetPasswordRequest(pesan)ResetPasswordResponse(pesan)SendVerificationCodeRequest(pesan)SendVerificationCodeRequest.AutoRetrievalInfo(pesan)SendVerificationCodeResponse(pesan)SetAccountInfoRequest(pesan)SetAccountInfoRequest.MfaInfo(pesan)SetAccountInfoRequest.UserAttributeName(enum)SetAccountInfoResponse(pesan)SignInWithCustomTokenRequest(pesan)SignInWithCustomTokenResponse(pesan)SignInWithEmailLinkRequest(pesan)SignInWithEmailLinkResponse(pesan)SignInWithGameCenterRequest(pesan)SignInWithGameCenterResponse(pesan)SignInWithIdpRequest(pesan)SignInWithIdpResponse(pesan)SignInWithPasswordRequest(pesan)SignInWithPasswordResponse(pesan)SignInWithPhoneNumberRequest(pesan)SignInWithPhoneNumberRequest.VerifyOp(enum)SignInWithPhoneNumberResponse(pesan)SignUpRequest(pesan)SignUpRequest.MfaFactor(pesan)SignUpResponse(pesan)TotpInfo(pesan)UploadAccountRequest(pesan)UploadAccountRequest.PasswordHashOrder(enum)UploadAccountResponse(pesan)UserInfo(pesan)UserNotification(pesan)UserNotification.NotificationCode(enum)VerifyIosClientRequest(pesan)VerifyIosClientResponse(pesan)
AccountManagementService
Pengelolaan akun untuk Identity Toolkit
| BatchDeleteAccounts |
|---|
|
Menghapus beberapa akun secara massal. Untuk akun yang gagal dihapus, info error akan disertakan dalam respons. Metode ini mengabaikan akun yang tidak ada atau diduplikasi dalam permintaan. Metode ini memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.
|
| DeleteAccount |
|---|
|
Menghapus akun pengguna.
|
| DownloadAccount |
|---|
|
Mendownload informasi akun untuk semua akun di project secara berpagi. Untuk menggunakan metode ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Selain itu, izin tambahan diperlukan untuk mendapatkan hash sandi, salt sandi, dan versi sandi dari akun. Jika tidak, kolom ini akan disamarkan.
|
| GetAccountInfo |
|---|
|
Mendapatkan informasi akun untuk semua akun yang cocok. Untuk permintaan pengguna akhir, mengambil akun pengguna akhir. Untuk permintaan admin dengan kredensial Google OAuth 2.0, mengambil satu atau beberapa akun dengan kriteria yang cocok.
|
| GetOobCode |
|---|
|
Mengirim kode konfirmasi di luar band untuk akun. Permintaan dari permintaan yang diautentikasi dapat secara opsional menampilkan link yang menyertakan kode OOB, bukan mengirimkannya.
|
| QueryUserInfo |
|---|
|
Mencari akun pengguna dalam project atau tenant berdasarkan kondisi dalam permintaan.
|
| ResetPassword |
|---|
|
Mereset sandi akun menggunakan kode out-of-band yang dihasilkan oleh [sendOobCode][v1.accounts.sendOobCode] atau dengan menentukan email dan sandi akun yang akan diubah. Juga dapat memeriksa tujuan kode out-of-band tanpa menggunakannya.
|
| SetAccountInfo |
|---|
|
Memperbarui informasi terkait akun untuk pengguna yang ditentukan dengan menetapkan kolom tertentu atau menerapkan kode tindakan. Permintaan dari administrator dan pengguna akhir didukung.
|
| UploadAccount |
|---|
|
Mengupload beberapa akun ke project Google Cloud. Jika ada masalah saat mengupload satu atau beberapa akun, akun lainnya akan diupload, dan daftar error akan ditampilkan. Untuk menggunakan metode ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.
|
AuthenticationService
Autentikasi untuk Identity Toolkit
| CreateAuthUri |
|---|
|
Jika ID email ditentukan, periksa dan tampilkan apakah ada akun pengguna yang terdaftar dengan email tersebut. Jika ada akun terdaftar, mengambil semua penyedia yang terkait dengan email akun. Jika ID penyedia Penyedia Identitas (IdP) ditentukan, buat URI otorisasi untuk IdP. Pengguna dapat diarahkan ke URI ini untuk login dengan IdP. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| GetPublicKeys |
|---|
|
Mengambil kunci publik penanda tangan token Identity Toolkit lama untuk memungkinkan pihak ketiga memverifikasi token ID lama. Untuk saat ini, sertifikat pem X509 adalah satu-satunya format yang didukung.
|
| GetRecaptchaParam |
|---|
|
Mendapatkan parameter yang diperlukan untuk membuat tantangan reCAPTCHA.
|
| IssueSamlResponse |
|---|
|
Eksperimental
|
| SendVerificationCode |
|---|
|
Mengirim kode verifikasi SMS untuk login dengan nomor telepon. Untuk melokalkan teks SMS yang dikirim kepada pengguna, tetapkan header HTTP Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignInWithCustomToken |
|---|
|
Memproses login atau pendaftaran pengguna dengan menukarkan token Auth kustom. Setelah login atau pendaftaran berhasil, token ID dan token refresh Identity Platform baru akan diterbitkan untuk pengguna. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignInWithEmailLink |
|---|
|
Login atau mendaftarkan pengguna dengan kode out-of-band dari link email. Jika pengguna tidak ada dengan alamat email yang diberikan, data pengguna akan dibuat. Jika login berhasil, ID Identity Platform dan token refresh akan diterbitkan untuk pengguna yang diautentikasi. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignInWithGameCenter |
|---|
|
Memproses login atau pendaftaran pengguna dengan kredensial Game Center iOS. Jika login berhasil, token ID dan token refresh Identity Platform baru akan dikeluarkan untuk pengguna yang diautentikasi. ID paket diperlukan di header permintaan sebagai Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud. Apple telah menghentikan penggunaan kolom Upgrade integrasi login Game Center yang ada ke SDK versi 10.5.0 atau yang lebih baru tidak dapat dibatalkan.
|
| SignInWithIdp |
|---|
|
Login atau mendaftarkan pengguna menggunakan kredensial dari Penyedia Identitas (IdP). Hal ini dilakukan dengan memberikan kredensial IdP secara manual, atau dengan memberikan respons otorisasi yang diperoleh melalui permintaan otorisasi dari CreateAuthUri. Jika login berhasil, token ID dan token refresh Identity Platform baru akan dikeluarkan untuk pengguna yang diautentikasi. Akun pengguna Identity Platform baru akan dibuat jika pengguna belum pernah login ke IdP dengan akun yang sama. Selain itu, jika setelan "Satu akun per alamat email" diaktifkan, tidak boleh ada akun pengguna Identity Platform yang sudah ada dengan alamat email yang sama agar akun pengguna baru dapat dibuat. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignInWithPassword |
|---|
|
Memproses login pengguna dengan email dan sandi. Jika login berhasil, token ID dan token refresh Identity Platform baru akan dikeluarkan untuk pengguna yang diautentikasi. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignInWithPhoneNumber |
|---|
|
Menyelesaikan upaya autentikasi nomor telepon. Jika pengguna sudah ada dengan nomor telepon yang diberikan, token ID akan dibuat untuk pengguna tersebut. Jika tidak, pengguna baru akan dibuat dan dikaitkan dengan nomor telepon. Metode ini juga dapat digunakan untuk menautkan nomor telepon ke pengguna yang sudah ada. Untuk melokalkan teks SMS yang dikirim kepada pengguna, tetapkan header HTTP Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| SignUp |
|---|
|
Mendaftarkan pengguna email dan sandi baru atau pengguna anonim, atau mengupgrade pengguna anonim ke email dan sandi. Untuk permintaan admin dengan kredensial Google OAuth 2.0 dengan izin yang sesuai, buat pengguna baru anonim, email dan sandi, atau nomor telepon. Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
| VerifyIosClient |
|---|
|
Memverifikasi bahwa klien iOS adalah perangkat iOS sungguhan. Jika permintaan valid, tanda terima akan dikirim dalam respons dan secret akan dikirim melalui Apple Push Notification Service. Klien harus mengirim keduanya kembali ke Identity Platform API tertentu dalam panggilan berikutnya (misalnya, /accounts:sendVerificationCode), untuk memverifikasi klien. ID paket diperlukan di header permintaan sebagai Kunci API diperlukan dalam permintaan untuk mengidentifikasi project Google Cloud.
|
ProjectConfigService
Konfigurasi project untuk Identity Toolkit
| GetProjectConfig |
|---|
|
Mendapatkan konfigurasi Identity Toolkit publik project. (Lama) Metode ini juga mendukung panggilan yang diautentikasi dari developer untuk mengambil konfigurasi non-publik.
|
SessionManagementService
Pengelolaan sesi untuk Identity Platform.
| CreateSessionCookie |
|---|
|
Membuat cookie sesi untuk token ID Identity Platform yang diberikan. Cookie sesi digunakan oleh klien untuk mempertahankan status login pengguna.
|
| GetSessionCookiePublicKeys |
|---|
|
Mengambil kumpulan kunci publik penanda tangan Token Web JSON (JWT) cookie sesi yang dapat digunakan untuk memvalidasi cookie sesi yang dibuat melalui [createSessionCookie][v1.projects.createSessionCookie]. |
Argon2Parameters
Parameter untuk algoritma hashing Argon2.
| Kolom | |
|---|---|
hash_length_bytes |
Wajib. Panjang hash yang diinginkan dalam byte. Minimum adalah 4 dan maksimum adalah 1024. |
hash_type |
Wajib. Tidak boleh HASH_TYPE_UNSPECIFIED. |
parallelism |
Wajib. Tingkat paralelisme, yang juga disebut thread atau jalur. Minimum adalah 1, maksimum adalah 16. |
iterations |
Wajib. Jumlah iterasi yang akan dilakukan. Minimum adalah 1, maksimum adalah 16. |
memory_cost_kib |
Wajib. Biaya memori dalam kibibyte. Maksimumnya adalah 32.768. |
version |
Versi algoritma Argon2. Jika tidak ditentukan, setelan defaultnya adalah VERSION_13. |
associated_data |
Data terkait tambahan, jika disediakan, akan ditambahkan ke nilai hash untuk memberikan lapisan keamanan tambahan. String berenkode base64 jika ditentukan melalui JSON. |
HashType
Jenis algoritma.
| Enum | |
|---|---|
HASH_TYPE_UNSPECIFIED |
Jenis hash tidak ditentukan. |
ARGON2_D |
Varian Argon2, Argon2d. |
ARGON2_ID |
Varian Argon2, Argonid. Direkomendasikan. |
ARGON2_I |
Varian Argon2, Argon2i. |
Versi
Versi algoritma.
| Enum | |
|---|---|
VERSION_UNSPECIFIED |
Versi tidak ditentukan. |
VERSION_10 |
Versi sebelumnya, 0x10. |
VERSION_13 |
Versi saat ini, 0x13. Nilai default untuk versi. |
BatchDeleteAccountsRequest
Pesan permintaan untuk BatchDeleteAccounts.
| Kolom | |
|---|---|
target_project_id |
Jika Otorisasi memerlukan izin IAM berikut pada resource
|
local_ids[] |
Wajib. Daftar ID pengguna yang akan dihapus. |
force |
Apakah akan memaksa penghapusan akun yang tidak dalam status dinonaktifkan. Jika salah, hanya akun yang dinonaktifkan yang akan dihapus, dan akun yang tidak dinonaktifkan akan ditambahkan ke |
tenant_id |
Jika akun tersebut milik tenant Identity Platform, ID tenant. Jika akun termasuk dalam project Identity Platform default, kolom ini tidak diperlukan. |
BatchDeleteAccountsResponse
Pesan respons ke BatchDeleteAccounts.
| Kolom | |
|---|---|
errors[] |
Info error mendetail untuk akun yang tidak dapat dihapus. |
BatchDeleteErrorInfo
Info error untuk akun gagal dihapus.
| Kolom | |
|---|---|
index |
Indeks item yang mengalami error di kolom local_ids asli. |
local_id |
ID pengguna yang sesuai. |
error_message |
Pesan error mendetail. |
ClientType
Jenis platform klien: web, android, atau ios.
| Enum | |
|---|---|
CLIENT_TYPE_UNSPECIFIED |
Jenis klien tidak ditentukan. |
CLIENT_TYPE_WEB |
Jenis klien adalah web. |
CLIENT_TYPE_ANDROID |
Jenis klien adalah android. |
CLIENT_TYPE_IOS |
Jenis klien adalah ios. |
CreateAuthUriRequest
Pesan permintaan untuk CreateAuthUri.
| Kolom | |
|---|---|
identifier |
ID email akun pengguna yang akan mengambil penyedia terkait. Setidaknya salah satu kolom Panjang alamat email harus kurang dari 256 karakter dan dalam format |
continue_uri |
URL yang valid untuk tujuan pengalihan pengguna kembali oleh IdP. URL tidak boleh berisi fragmen atau parameter kueri |
openid_realm |
|
provider_id |
ID penyedia IdP yang akan digunakan pengguna untuk login. Ini harus berupa ID penyedia yang diaktifkan untuk login, yang berasal dari daftar IdP default yang didukung, atau dalam format |
oauth_consumer_key |
|
oauth_scope |
Cakupan OAuth 2.0 tambahan yang dipisahkan spasi yang menentukan cakupan permintaan autentikasi dengan IdP. Digunakan untuk IdP OAuth 2.0. Untuk penyedia Google, alur kode otorisasi akan digunakan jika kolom ini ditetapkan. |
context |
String buram yang digunakan untuk mempertahankan informasi kontekstual antara permintaan autentikasi dan callback dari IdP. |
ota_app |
|
app_id |
|
hosted_domain |
Digunakan untuk penyedia Google. Domain pengguna yang dihosting G Suite untuk membatasi login bagi pengguna di domain tersebut. |
session_id |
ID sesi yang dapat diverifikasi di SignInWithIdp untuk mencegah serangan fiksasi sesi. Jika tidak ada, string acak akan dibuat dan ditampilkan sebagai ID sesi. |
auth_flow_type |
Digunakan untuk penyedia Google. Jenis alur autentikasi yang akan digunakan. Jika ada, nilai ini harus |
custom_parameter |
Parameter kueri kustom tambahan yang akan ditambahkan ke URI otorisasi. Parameter berikut dicadangkan dan tidak dapat ditambahkan: Untuk penyedia Microsoft, tenant Azure AD yang akan digunakan untuk login dapat ditentukan dalam parameter kustom |
tenant_id |
ID tenant Identity Platform untuk membuat URI otorisasi atau mencari ID email. Jika tidak ditetapkan, operasi akan dilakukan di instance Identity Platform default dalam project. |
CreateAuthUriResponse
Pesan respons untuk CreateAuthUri.
| Kolom | |
|---|---|
kind |
|
auth_uri |
URI otorisasi untuk penyedia yang diminta. Hanya ada jika ID penyedia ditetapkan dalam permintaan. |
all_providers[] |
|
registered |
Apakah ID email mewakili akun yang ada. Hanya ada jika ID email ditetapkan dalam permintaan. |
provider_id |
ID penyedia dari permintaan, jika disediakan. |
for_existing_provider |
Apakah pengguna sebelumnya telah login dengan ID penyedia dalam permintaan. Hanya ada jika ID email terdaftar ditetapkan dalam permintaan. |
captcha_required |
Apakah CAPTCHA diperlukan karena ada terlalu banyak upaya login yang gagal oleh pengguna. Hanya ada jika ID email terdaftar ditetapkan dalam permintaan. |
session_id |
ID sesi dari permintaan, atau string acak yang dihasilkan oleh CreateAuthUri jika tidak ada. Fungsi ini digunakan untuk mencegah serangan fiksasi sesi. |
signin_methods[] |
Daftar metode login yang sebelumnya digunakan pengguna. Setiap elemen adalah salah satu dari |
CreateSessionCookieRequest
Pesan permintaan untuk CreateSessionCookie.
| Kolom | |
|---|---|
id_token |
Wajib. Token ID Identity Platform yang valid. |
valid_duration |
Jumlah detik hingga cookie sesi berakhir masa berlakunya. Tentukan durasi dalam detik, antara lima menit dan empat belas hari, secara inklusif. |
target_project_id |
ID project tempat akun tersebut berada. |
tenant_id |
ID tenant tenant Identity Platform tempat akun berada. |
CreateSessionCookieResponse
Pesan respons untuk CreateSessionCookie.
| Kolom | |
|---|---|
session_cookie |
Cookie sesi yang telah dibuat dari token ID Identity Platform yang ditentukan dalam permintaan. Token ini berbentuk Token Web JSON (JWT). Selalu ada. |
DeleteAccountRequest
Pesan permintaan untuk DeleteAccount.
| Kolom | |
|---|---|
local_id |
ID akun pengguna yang akan dihapus. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Permintaan dari pengguna yang tidak memiliki kredensial harus meneruskan token ID. |
delegated_project_number |
|
id_token |
Token ID Identity Platform dari akun yang akan dihapus. Wajib ditentukan untuk permintaan dari pengguna akhir yang tidak memiliki kredensial Google OAuth 2.0. Permintaan yang diautentikasi yang memiliki kredensial Google OAuth2 dengan izin yang tepat dapat meneruskan local_id untuk menentukan akun yang akan dihapus secara alternatif. |
tenant_id |
ID tenant tempat akun berada, jika ada. Hanya perlu ditentukan untuk permintaan yang diautentikasi yang memiliki kredensial Google OAuth 2.0 yang menentukan local_id akun yang dimiliki oleh tenant Identity Platform. |
target_project_id |
ID project tempat akun tersebut berada. Hanya boleh ditentukan dalam permintaan yang diautentikasi yang menentukan local_id akun. Otorisasi memerlukan izin IAM berikut pada resource
|
DeleteAccountResponse
Pesan respons untuk DeleteAccount.
| Kolom | |
|---|---|
kind |
|
DownloadAccountRequest
Pesan permintaan untuk DownloadAccount
| Kolom | |
|---|---|
delegated_project_number |
|
next_page_token |
Token penomoran halaman dari respons permintaan sebelumnya. |
max_results |
Jumlah hasil maksimum yang akan ditampilkan. Harus minimal 1 dan tidak lebih dari 1.000. Secara default, nilainya adalah 20. |
target_project_id |
Jika Otorisasi memerlukan izin IAM berikut pada resource
|
tenant_id |
ID tenant Identity Platform tempat akun berada. Jika tidak ditentukan, akun di project Identity Platform akan ditampilkan. |
DownloadAccountResponse
Pesan respons untuk DownloadAccount.
| Kolom | |
|---|---|
kind |
|
users[] |
Semua akun milik project/tenant yang dibatasi oleh max_results dalam permintaan. |
next_page_token |
Jika ada lebih banyak akun yang akan didownload, token yang dapat diteruskan kembali ke DownloadAccount untuk mendapatkan lebih banyak akun. Jika tidak, kolom ini akan kosong. |
EmailInfo
Informasi tentang MFA email.
| Kolom | |
|---|---|
email_address |
Alamat email tempat verifikasi MFA akan dikirim. |
EmailTemplate
Template email
| Kolom | |
|---|---|
disabled |
Apakah template dinonaktifkan. Jika benar, template default akan digunakan. |
from |
Alamat pengirim email |
body |
Isi email |
subject |
Subjek email |
from_display_name |
Dari nama tampilan |
format |
Format isi email |
reply_to |
Alamat balas-ke |
from_local_part |
Bagian lokal dari alamat Pengirim |
locale |
Nilai dalam format kode bahasa III (misalnya, "zh-CN", "es"). Pemisah '-' dan '_' diterima. |
customized |
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. |
ErrorInfo
Informasi error yang menjelaskan alasan akun tidak dapat diupload. upload massal.
| Kolom | |
|---|---|
index |
Indeks item, rentangnya adalah [0, request.size - 1] |
error_message |
Pesan error mendetail |
GetAccountInfoRequest
Pesan permintaan untuk GetAccountInfo.
| Kolom | |
|---|---|
id_token |
Token ID Identity Platform dari akun yang akan diambil. Wajib ditentukan untuk permintaan dari pengguna akhir. |
local_id[] |
ID satu atau beberapa akun yang akan diambil. Hanya boleh ditentukan oleh permintaan terautentikasi yang memiliki kredensial Google OAuth 2.0 dengan izin yang sesuai. |
email[] |
Alamat email satu atau beberapa akun yang akan diambil. Panjang email harus kurang dari 256 karakter dan dalam format |
delegated_project_number |
|
phone_number[] |
Nomor telepon satu atau beberapa akun yang akan diambil. Hanya boleh ditentukan oleh permintaan terautentikasi dari developer dan harus dalam format E.164, misalnya, +15555555555. |
federated_user_id[] |
|
tenant_id |
ID tenant tempat akun berada. Hanya boleh ditentukan oleh permintaan terautentikasi dari developer. |
target_project_id |
ID project Google Cloud yang menjadi milik akun atau tenant Identity Platform yang ditentukan oleh Otorisasi memerlukan izin IAM berikut pada resource
|
initial_email[] |
Email awal dari satu atau beberapa akun yang akan diambil. Panjang email harus kurang dari 256 karakter dan dalam format |
FederatedUserIdentifier
ID pengguna gabungan di Penyedia Identitas.
| Kolom | |
|---|---|
provider_id |
ID penyedia identitas yang didukung. Ini harus berupa ID penyedia yang diaktifkan untuk login, yang berasal dari daftar IdP default yang didukung, atau dalam format |
raw_id |
ID pengguna akun di Penyedia Identitas pihak ketiga yang ditentukan oleh |
GetAccountInfoResponse
Pesan respons untuk GetAccountInfo.
| Kolom | |
|---|---|
kind |
|
users[] |
Informasi akun pengguna tertentu yang cocok dengan parameter dalam permintaan. |
GetOobCodeRequest
Pesan permintaan untuk GetOobCode.
| Kolom | |
|---|---|
req_type |
Wajib. Jenis kode out-of-band (OOB) yang akan dikirim. Bergantung pada nilai ini, kolom lain dalam permintaan ini akan diperlukan dan/atau memiliki arti yang berbeda. Ada 4 kode OOB berbeda yang dapat dikirim: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL |
email |
Alamat email akun yang akan menerima kode OOB, dan umumnya alamat email akun yang perlu diperbarui. Wajib ada untuk PASSWORD_RESET, EMAIL_SIGNIN, dan VERIFY_EMAIL. Hanya diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL jika return_oob_link ditetapkan ke benar. Dalam hal ini, email tersebut adalah email asli pengguna. |
challenge |
|
captcha_resp |
Untuk permintaan PASSWORD_RESET, respons reCaptcha diperlukan saat sistem mendeteksi kemungkinan aktivitas penyalahgunaan. Dalam kasus tersebut, ini adalah respons dari tantangan reCaptcha yang digunakan untuk memverifikasi pemanggil. |
user_ip |
Alamat IP pemanggil. Hanya diperlukan untuk permintaan PASSWORD_RESET. |
new_email |
Alamat email yang akan digunakan untuk akun. Hanya diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL. |
id_token |
Token ID untuk akun. Ini diperlukan untuk permintaan VERIFY_AND_CHANGE_EMAIL dan VERIFY_EMAIL, kecuali jika return_oob_link ditetapkan ke true. |
continue_url |
URL untuk melanjutkan setelah pengguna mengklik link yang dikirim dalam email. Ini adalah URL yang akan memungkinkan widget web menangani kode OOB. |
ios_bundle_id |
Jika aplikasi iOS terkait dapat menangani kode OOB, ID paket iOS aplikasi ini. Tindakan ini akan memungkinkan aplikasi yang benar untuk terbuka jika sudah diinstal. |
ios_app_store_id |
Jika aplikasi iOS terkait dapat menangani kode OOB, ID App Store aplikasi ini. Tindakan ini akan memungkinkan App Store membuka aplikasi yang benar jika aplikasi belum diinstal. |
android_package_name |
Jika aplikasi Android terkait dapat menangani kode OOB, nama paket Android dari aplikasi Android yang akan menangani callback saat kode OOB ini digunakan. Tindakan ini akan memungkinkan aplikasi yang benar untuk dibuka jika sudah diinstal, atau memungkinkan Google Play Store membuka aplikasi yang benar jika belum diinstal. |
android_install_app |
Jika aplikasi Android terkait dapat menangani kode OOB, apakah akan menginstal aplikasi Android di perangkat tempat link dibuka atau tidak jika aplikasi belum diinstal. |
android_minimum_version_code |
Jika aplikasi Android terkait dapat menangani kode OOB, versi minimum aplikasi. Jika versi di perangkat lebih rendah dari versi ini, pengguna akan diarahkan ke Google Play Store untuk mengupgrade aplikasi. |
can_handle_code_in_app |
Jika disetel ke benar (true), link kode OOB akan dikirim sebagai Link Universal atau Link Aplikasi Android dan akan dibuka oleh aplikasi yang sesuai jika sudah terinstal. Jika tidak ditetapkan, atau ditetapkan ke salah, kode OOB akan dikirim ke widget web terlebih dahulu, lalu akan dialihkan ke aplikasi jika diinstal. |
tenant_id |
ID tenant tenant Identity Platform tempat akun berada. |
target_project_id |
Project ID project Identity Platform tempat akun berada. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Otorisasi memerlukan izin IAM berikut pada resource
|
dynamic_link_domain |
Untuk memastikan bahwa URL yang digunakan dapat dibuka dengan mudah di iOS atau Android, kita membuat Firebase Dynamic Link. Sebagian besar project Identity Platform hanya akan mengaktifkan satu domain Dynamic Links, dan dapat mengosongkan kolom ini. Kolom ini berisi domain Dynamic Link yang ditentukan untuk project yang mengaktifkan beberapa domain. |
return_oob_link |
Apakah link konfirmasi yang berisi kode OOB harus ditampilkan dalam respons (tidak ada email yang dikirim). Digunakan saat developer ingin membuat template email dan mengirimkannya sendiri. Secara default, nilainya adalah salah (false); untuk menentukan kolom ini, dan menetapkannya ke benar (true), Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai |
client_type |
Jenis klien: web, Android, atau iOS. Wajib diisi saat perlindungan reCAPTCHA Enterprise diaktifkan. |
recaptcha_version |
Versi reCAPTCHA dari token reCAPTCHA di captcha_response. |
link_domain |
Opsional. Untuk memastikan bahwa URL yang digunakan dapat dibuka dengan mudah di iOS atau Android, kita membuat link Hosting '/__/auth/links'. Kolom opsional ini berisi domain yang akan digunakan saat membuat link Hosting. Jika tidak ditetapkan, domain ' |
GetOobCodeResponse
Pesan respons untuk GetOobCode.
| Kolom | |
|---|---|
kind |
|
oob_code |
Jika return_oob_link bernilai benar dalam permintaan, kode OOB akan dikirim. |
email |
Jika return_oob_link bernilai salah dalam permintaan, alamat email tempat verifikasi dikirim. |
oob_link |
Jika return_oob_link bernilai benar dalam permintaan, link OOB akan dikirim ke pengguna. Tindakan ini akan menampilkan link yang dibuat, termasuk parameter terkait Firebase Dynamic Link. |
GetProjectConfigRequest
Pesan permintaan untuk GetProjectconfig.
| Kolom | |
|---|---|
delegated_project_number |
Nomor Project permintaan project yang didelegasikan. Kolom ini hanya boleh digunakan sebagai bagian dari migrasi Firebase V1. |
project_number |
Nomor project konfigurasi yang akan diambil. Kolom ini tidak digunakan lagi dan tidak boleh digunakan oleh integrasi baru. |
return_dynamic_link |
Apakah link dinamis harus ditampilkan. |
android_package_name |
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. |
ios_bundle_id |
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. |
client_id |
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. |
sha1_cert |
Hash sertifikat aplikasi Android SHA-1. Jika ditetapkan, pemeriksaan akan dilakukan untuk memastikan bahwa hash sertifikat valid untuk project yang diambil dan android_package_name. |
firebase_app_id |
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. |
GetProjectConfigResponse
Pesan respons untuk GetProjectConfig.
| Kolom | |
|---|---|
project_id |
Project ID konfigurasi yang diambil. |
api_key |
Kunci Google Cloud API. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
allow_password_user |
Apakah akan mengizinkan pendaftaran akun sandi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
idp_config[] |
Konfigurasi penyedia OAuth2. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
authorized_domains[] |
Domain yang diizinkan untuk pengalihan widget. |
enable_anonymous_user |
Apakah pengguna anonim diaktifkan. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
dynamic_links_domain |
Domain Firebase Dynamic Links yang digunakan untuk membuat link untuk pengalihan ke aplikasi native. |
use_email_sending |
Apakah akan menggunakan pengiriman email. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
reset_password_template |
Template email untuk mereset sandi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
verify_email_template |
Template email untuk email verifikasi. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
change_email_template |
Template email untuk email perubahan. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
legacy_reset_password_template |
Template email reset sandi untuk aplikasi Firebase V1 lama. Kolom ini hanya ditampilkan untuk panggilan yang diautentikasi dari developer. |
revert_second_factor_addition_template |
Template email untuk mengembalikan penambahan faktor kedua. Kolom ini hanya ditampilkan untuk panggilan terautentikasi dari developer. |
GetRecaptchaParamResponse
Pesan respons untuk GetRecaptchaParam.
| Kolom | |
|---|---|
kind |
|
recaptcha_stoken |
|
recaptcha_site_key |
Kunci situs reCAPTCHA v2 yang digunakan untuk memanggil layanan reCAPTCHA. Selalu ada. |
producer_project_number |
Nomor project produsen yang digunakan untuk membuat token PIA |
GetSessionCookiePublicKeysResponse
Pesan respons untuk GetSessionCookiePublicKeys.
| Kolom | |
|---|---|
keys[] |
Kunci publik penanda tangan cookie sesi, yang diformat sebagai Kunci Web JSON (JWK). |
IdpConfig
Konfigurasi penyedia identitas.
| Kolom | |
|---|---|
provider |
|
enabled |
Benar jika mengizinkan pengguna login dengan penyedia. |
experiment_percent |
Persentase pengguna yang akan diminta/dialihkan ke login gabungan untuk IdP ini |
key |
Client ID OAuth2. |
secret |
Rahasia klien OAuth2. |
whitelisted_audiences[] |
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. |
IssueSamlResponseRequest
Pesan permintaan untuk IssueSamlResponse.
| Kolom | |
|---|---|
rp_id |
ID Pihak Tepercaya, yang merupakan audiens SAMLResponse yang diterbitkan. |
id_token |
Token ID Identity Platform. Token ini akan diverifikasi, lalu dikonversi menjadi SAMLResponse baru. |
saml_app_entity_id |
ID entitas aplikasi SAML yang ditentukan di Konsol Google Admin untuk setiap aplikasi. Jika developer ingin mengalihkan ke aplikasi pihak ketiga, bukan aplikasi G Suite, mereka mungkin memerlukannya. Saat digunakan, kita akan menampilkan RelayState. Ini termasuk SAMLRequest, yang dapat digunakan untuk memicu alur SAML yang dimulai SP untuk mengalihkan ke aplikasi yang sebenarnya. |
IssueSamlResponseResponse
Respons untuk permintaan IssueSamlResponse.
| Kolom | |
|---|---|
saml_response |
SAMLResponse yang ditandatangani dibuat untuk Pihak Penerima. |
acs_endpoint |
Endpoint ACS yang menggunakan SAMLResponse yang ditampilkan. |
relay_state |
RelayState yang dibuat. |
email |
Email pengguna. |
first_name |
Nama depan pengguna. |
last_name |
Nama belakang pengguna. |
is_new_user |
Apakah pengguna yang login dibuat oleh permintaan ini. |
MfaEnrollment
Informasi tentang penyedia autentikasi multi-faktor (MFA) yang diaktifkan untuk akun.
| Kolom | |
|---|---|
mfa_enrollment_id |
ID opsi MFA ini. |
display_name |
Nama tampilan untuk opsi MFA ini, misalnya "ponsel perusahaan". |
enrolled_at |
Stempel waktu saat akun mendaftarkan faktor kedua ini. |
Kolom union mfa_value. Nilai penentu opsi MFA. mfa_value hanya ada berupa salah satu diantara berikut: |
|
phone_info |
Biasanya, opsi ini akan menampilkan nomor telepon yang terkait dengan pendaftaran ini. Dalam beberapa situasi, seperti setelah login faktor pertama, hanya versi yang di-obfuscate dari nomor telepon terkait yang akan ditampilkan. |
totp_info |
Berisi informasi khusus untuk TOTP MFA. |
email_info |
Berisi informasi khusus untuk MFA email. |
Kolom union
|
|
unobfuscated_phone_info |
Hanya output. phone_info yang tidak di-obfuscate. |
OobReqType
Jenis tindakan yang diminta untuk kode OOB.
| Enum | |
|---|---|
OOB_REQ_TYPE_UNSPECIFIED |
Jenis kode Oob tidak ditentukan. |
PASSWORD_RESET |
setel ulang sandi |
OLD_EMAIL_AGREE |
|
NEW_EMAIL_ACCEPT |
|
VERIFY_EMAIL |
memverifikasi alamat email akun dengan mengirim email |
RECOVER_EMAIL |
|
EMAIL_SIGNIN |
login dengan email saja |
VERIFY_AND_CHANGE_EMAIL |
Alur ini mengirim email ke email baru yang ditentukan, dan saat diterapkan dengan mengklik link dalam email, email akun akan diubah menjadi email baru. Digunakan jika akun harus memiliki email terverifikasi setiap saat, seperti akun MFA. |
REVERT_SECOND_FACTOR_ADDITION |
|
OpenIdConnectKey
Merepresentasikan kunci publik penanda tangan cookie sesi, yang diformat sebagai Kunci Web JSON (JWK).
| Kolom | |
|---|---|
type |
Jenis kunci. |
algorithm |
Algoritma tanda tangan. |
use |
Penggunaan kunci. |
id |
String unik untuk mengidentifikasi kunci ini. |
modulus |
Modulus untuk kunci publik RSA, yang direpresentasikan sebagai encoding base64url dari representasi big endian nilai. |
exponent |
Eksponen untuk kunci publik RSA, yang direpresentasikan sebagai encoding base64url dari representasi big endian nilai. |
ProviderUserInfo
Informasi tentang pengguna seperti yang disediakan oleh berbagai Penyedia Identitas.
| Kolom | |
|---|---|
provider_id |
ID Penyedia Identitas. |
display_name |
Nama tampilan pengguna di Penyedia Identitas. |
photo_url |
URL foto profil pengguna di Penyedia Identitas. |
federated_id |
ID pengguna di Penyedia Identitas. |
email |
Alamat email pengguna di Penyedia Identitas. |
raw_id |
ID mentah pengguna yang ditampilkan langsung dari Penyedia Identitas. |
screen_name |
screen_name pengguna di Twitter atau nama login di GitHub. |
phone_number |
Nomor telepon pengguna di Penyedia Identitas. |
QueryUserInfoRequest
Pesan permintaan untuk QueryUserInfo.
| Kolom | |
|---|---|
return_user_info |
Jika |
limit |
Jumlah maksimum akun yang akan ditampilkan dengan batas atas 500. Setelan defaultnya adalah 500. Hanya valid jika |
offset |
Jumlah akun yang akan dilewati dari awal data yang cocok. Hanya valid jika |
sort_by |
|
order |
|
target_project_id |
ID project yang menjadi cakupan hasil. Otorisasi memerlukan izin IAM berikut pada resource
|
tenant_id |
ID tenant yang menjadi cakupan hasil. |
expression[] |
|
Pesanan
Urutan untuk mengurutkan hasil kueri.
| Enum | |
|---|---|
ORDER_UNSPECIFIED |
Urutan tidak ditentukan. |
ASC |
Urutkan dari atas ke bawah. |
DESC |
Urutkan dari atas ke bawah. |
SortByField
Kolom yang akan digunakan untuk mengurutkan akun pengguna.
| Enum | |
|---|---|
SORT_BY_FIELD_UNSPECIFIED |
Kolom pengurutan tidak ditentukan. |
USER_ID |
Urutkan hasil menurut userId. |
NAME |
Urutkan hasil menurut nama. |
CREATED_AT |
Mengurutkan hasil berdasarkan createdAt. |
LAST_LOGIN_AT |
Urutkan hasil menurut lastLoginAt. |
USER_EMAIL |
Urutkan hasil menurut userEmail. |
SqlExpression
Kondisi kueri yang digunakan untuk memfilter hasil.
| Kolom | |
|---|---|
email |
String yang tidak peka huruf besar/kecil yang harus cocok dengan email akun. Hanya satu dari |
user_id |
String yang harus cocok dengan ID lokal akun. Hanya satu dari |
phone_number |
String yang harus cocok dengan nomor telepon akun. Hanya satu dari |
QueryUserInfoResponse
Pesan respons untuk QueryUserInfo.
| Kolom | |
|---|---|
records_count |
Jika |
user_info[] |
Jika |
RecaptchaVersion
Versi reCAPTCHA.
| Enum | |
|---|---|
RECAPTCHA_VERSION_UNSPECIFIED |
Versi reCAPTCHA tidak ditentukan. |
RECAPTCHA_ENTERPRISE |
reCAPTCHA Enterprise. |
ResetPasswordRequest
Pesan permintaan untuk ResetPassword.
| Kolom | |
|---|---|
oob_code |
Kode out-of-band (OOB) yang dihasilkan oleh permintaan GetOobCode. Tentukan hanya parameter ini (atau hanya parameter ini dan ID tenant) untuk mendapatkan jenis kode out-of-band dalam respons tanpa mengubah status akun. Hanya kode out-of-band PASSWORD_RESET yang dapat digunakan melalui metode ini. |
new_password |
Sandi baru yang akan ditetapkan untuk akun ini. Menentukan kolom ini akan menyebabkan perubahan pada akun dan menggunakan kode out-of-band jika ditentukan dan berjenis PASSWORD_RESET. |
old_password |
Sandi akun saat ini yang akan diubah. Tentukan ini dan email untuk mengubah sandi akun tanpa menggunakan kode out-of-band. |
email |
Opsional. Email akun yang akan diubah. Tentukan kode ini dan sandi lama untuk mengubah sandi akun tanpa menggunakan kode out-of-band. |
tenant_id |
Opsional. ID tenant tenant Identity Platform tempat akun berada. |
ResetPasswordResponse
Pesan respons untuk ResetPassword.
| Kolom | |
|---|---|
kind |
|
email |
Email yang terkait dengan kode out-of-band yang digunakan. |
new_email |
|
req_type |
|
mfa_info |
|
SendVerificationCodeRequest
Pesan permintaan untuk SendVerificationCode. 'captcha_response' diperlukan saat reCAPTCHA Enterprise diaktifkan, atau setidaknya salah satu dari (ios_receipt dan ios_secret), recaptcha_token, atau safety_net_token harus ditentukan untuk memverifikasi bahwa kode verifikasi dikirim atas nama aplikasi sungguhan, bukan emulator.
| Kolom | |
|---|---|
phone_number |
Nomor telepon yang akan menerima kode verifikasi dalam format E.164. |
ios_receipt |
Tanda terima validasi token aplikasi iOS yang berhasil. Setidaknya salah satu dari ( |
ios_secret |
Secret dikirim ke aplikasi iOS sebagai notifikasi push. Harus diteruskan dengan |
recaptcha_token |
Token Recaptcha untuk verifikasi aplikasi. Setidaknya salah satu dari ( |
tenant_id |
ID tenant tenant Identity Platform tempat pengguna login. |
auto_retrieval_info |
Khusus Android. Digunakan oleh Layanan Google Play untuk mengidentifikasi aplikasi untuk pengambilan otomatis. |
safety_net_token |
Khusus Android. Digunakan untuk menyatakan identitas aplikasi sebagai pengganti token recaptcha. Setidaknya salah satu dari ( |
play_integrity_token |
Khusus Android. Digunakan untuk menyatakan identitas aplikasi sebagai pengganti token recaptcha (dan safety_net_token). Setidaknya salah satu dari ( |
captcha_response |
Opsional. Token reCAPTCHA Enterprise yang disediakan oleh integrasi sisi klien reCAPTCHA. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
client_type |
Opsional. Jenis klien, web, android, atau ios. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
recaptcha_version |
Opsional. Versi reCAPTCHA dari token reCAPTCHA di captcha_response. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
AutoRetrievalInfo
Informasi yang diperlukan untuk mengambil SMS secara otomatis.
| Kolom | |
|---|---|
app_signature_hash |
Hash tanda tangan aplikasi Android untuk SMS Retriever API Layanan Google Play. |
SendVerificationCodeResponse
Pesan respons untuk SendVerificationCode.
| Kolom | |
|---|---|
session_info |
Informasi sesi terenkripsi. Ini dapat digunakan di [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] untuk mengautentikasi nomor telepon. |
SetAccountInfoRequest
Pesan permintaan untuk SetAccountInfo.
| Kolom | |
|---|---|
id_token |
Token ID Identity Platform yang valid. Wajib diisi saat mencoba mengubah informasi terkait pengguna. |
local_id |
ID pengguna. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Untuk permintaan dari pengguna akhir, token ID harus diteruskan. |
display_name |
Nama tampilan baru pengguna yang akan diperbarui di atribut akun. Panjang nama tampilan harus kurang dari atau sama dengan 256 karakter. |
email |
Email baru pengguna yang akan diperbarui di atribut akun. Panjang email harus kurang dari 256 karakter dan dalam format |
password |
Sandi baru pengguna yang akan diperbarui di atribut akun. Panjang sandi minimal harus 6 karakter. |
provider[] |
Penyedia Identitas yang akan dikaitkan dengan akun. |
oob_code |
Kode out-of-band yang akan diterapkan di akun pengguna. Jenis kode out-of-band berikut didukung: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL |
email_verified |
Apakah email pengguna telah diverifikasi. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
upgrade_to_federated_login |
Apakah akun harus dibatasi agar hanya menggunakan login gabungan. |
captcha_challenge |
|
captcha_response |
Respons dari tantangan reCaptcha. Hal ini diperlukan saat sistem mendeteksi kemungkinan aktivitas penyalahgunaan. |
valid_since |
Menentukan stempel waktu minimum dalam detik agar token ID Identity Platform dianggap valid. |
disable_user |
Jika benar, akun akan ditandai sebagai dinonaktifkan, yang berarti pengguna tidak akan dapat login lagi. |
instance_id |
|
delegated_project_number |
|
photo_url |
URL foto baru pengguna untuk foto profil akun yang akan diperbarui di atribut akun. Panjang URL harus kurang dari atau sama dengan 2.048 karakter. |
delete_attribute[] |
|
return_secure_token |
Apakah akan menampilkan ID dan token refresh atau tidak. Harus selalu benar. |
delete_provider[] |
Penyedia Identitas yang akan dibatalkan tautannya dari akun pengguna. |
last_login_at |
Stempel waktu dalam milidetik saat akun terakhir kali login. |
created_at |
Stempel waktu dalam milidetik saat akun dibuat. |
phone_number |
Nomor telepon yang akan diperbarui di atribut akun. |
custom_attributes |
Atribut kustom berformat JSON yang akan disimpan di token ID Identity Platform. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
tenant_id |
ID tenant tenant Identity Platform tempat akun berada. Permintaan dari pengguna akhir harus meneruskan token ID Identity Platform, bukan menetapkan kolom ini. |
target_project_id |
Project ID untuk project tempat akun berada. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Permintaan dari pengguna akhir harus meneruskan token ID Identity Platform. Otorisasi memerlukan izin IAM berikut pada resource
|
mfa |
Informasi terkait autentikasi multi-faktor yang akan ditetapkan di akun pengguna. Tindakan ini akan menimpa informasi terkait multi-faktor sebelumnya di akun. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
link_provider_user_info |
Penyedia yang akan ditautkan ke akun pengguna. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
MfaInfo
Informasi terkait autentikasi multi-faktor.
| Kolom | |
|---|---|
enrollments[] |
Faktor kedua yang telah didaftarkan pengguna. |
UserAttributeName
Atribut akun yang dapat dihapus.
| Enum | |
|---|---|
USER_ATTRIBUTE_NAME_UNSPECIFIED |
Nama atribut pengguna tidak ditentukan. |
EMAIL |
Nama kunci atribut pengguna adalah email. |
DISPLAY_NAME |
Nama kunci atribut pengguna adalah displayName. |
PROVIDER |
Nama kunci atribut pengguna adalah provider. |
PHOTO_URL |
Nama kunci atribut pengguna adalah photoURL. |
PASSWORD |
Nama kunci atribut pengguna adalah sandi. |
RAW_USER_INFO |
Nama kunci atribut pengguna adalah rawUserInfo. |
SetAccountInfoResponse
Pesan respons untuk SetAccountInfo
| Kolom | |
|---|---|
kind |
|
local_id |
ID pengguna yang diautentikasi. |
email |
Alamat email akun. |
display_name |
Nama tampilan akun. |
id_token |
Token ID Identity Platform untuk akun. Ini digunakan untuk pendaftaran pengguna lama. |
provider_user_info[] |
Penyedia Identitas tertaut di akun. |
new_email |
Email baru yang telah ditetapkan pada atribut akun pengguna. |
photo_url |
URL foto pengguna untuk foto profil akun. |
refresh_token |
Token refresh untuk akun. Ini digunakan untuk pendaftaran pengguna lama. |
expires_in |
Jumlah detik hingga masa berlaku token ID Identity Platform berakhir. |
password_hash |
Tidak digunakan lagi. Saat ini tidak ada hash sandi yang sebenarnya yang ditampilkan. |
email_verified |
Apakah email akun telah diverifikasi. |
SignInWithCustomTokenRequest
Pesan permintaan untuk SignInWithCustomToken.
| Kolom | |
|---|---|
token |
Wajib. Token Auth kustom yang dinyatakan oleh developer. Token harus berupa Token Web JSON (JWT) yang menyertakan klaim yang tercantum dalam referensi API di bagian "Klaim Token Kustom". |
instance_id |
|
return_secure_token |
Harus selalu benar. |
delegated_project_number |
|
tenant_id |
ID tenant Identity Platform tempat pengguna login. Jika ada, ID harus cocok dengan tenant_id dalam token. |
SignInWithCustomTokenResponse
Pesan respons untuk SignInWithCustomToken.
| Kolom | |
|---|---|
kind |
|
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
refresh_token |
Token refresh Identity Platform untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID berakhir. |
is_new_user |
Apakah pengguna yang diautentikasi dibuat oleh permintaan ini. |
SignInWithEmailLinkRequest
Pesan permintaan untuk SignInWithEmailLink
| Kolom | |
|---|---|
oob_code |
Wajib. Kode out-of-band dari link email. |
email |
Wajib. Alamat email tujuan pengiriman link login. Panjang email harus kurang dari 256 karakter dan dalam format |
id_token |
Token ID yang valid untuk akun Identity Platform. Jika diteruskan, permintaan ini akan menautkan alamat email ke pengguna yang diwakili oleh token ID ini dan mengaktifkan login dengan penautan email di akun untuk masa mendatang. |
tenant_id |
ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default. |
SignInWithEmailLinkResponse
Pesan respons untuk SignInWithEmailLink.
| Kolom | |
|---|---|
kind |
|
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
email |
Email yang digunakan pengguna untuk login. Selalu ada dalam respons. |
refresh_token |
Token refresh untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID habis. |
local_id |
ID pengguna yang diautentikasi. Selalu ada dalam respons. |
is_new_user |
Apakah pengguna yang diautentikasi dibuat oleh permintaan ini. |
mfa_pending_credential |
String buram yang berfungsi sebagai bukti bahwa pengguna telah berhasil lulus pemeriksaan faktor pertama. |
mfa_info[] |
Info tentang penyedia autentikasi multi-faktor yang diaktifkan. Ada jika pengguna perlu menyelesaikan login menggunakan autentikasi multi-faktor. |
SignInWithGameCenterRequest
Pesan permintaan untuk SignInWithGameCenter
| Kolom | |
|---|---|
player_id |
Wajib. ID pemain Game Center pengguna. Tidak digunakan lagi oleh Apple. Teruskan |
public_key_url |
Wajib. URL untuk mengambil kunci publik Apple guna memverifikasi tanda tangan yang diberikan ditandatangani oleh Apple. |
signature |
Wajib. Data tanda tangan verifikasi yang dihasilkan oleh Apple. |
salt |
Wajib. String acak yang digunakan untuk membuat tanda tangan yang diberikan. |
timestamp |
Wajib. Waktu saat tanda tangan dibuat oleh Apple, dalam milidetik sejak epoch. |
id_token |
Token ID yang valid untuk akun Identity Platform. Jika ada, permintaan ini akan menautkan ID pemain Game Center ke akun yang diwakili oleh token ID ini. |
display_name |
Nama tampilan Game Center pengguna. |
tenant_id |
ID tenant Identity Platform tempat pengguna login. |
team_player_id |
ID pemain tim Game Center pengguna. ID unik untuk pemain dari semua game yang Anda distribusikan menggunakan akun developer. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
ID pemain game Game Center pengguna. ID unik untuk pemain game. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithGameCenterResponse
Pesan respons untuk SignInWithGameCenter
| Kolom | |
|---|---|
local_id |
ID pengguna yang diautentikasi. Selalu ada dalam respons. |
player_id |
ID pemain Game Center pengguna. Teruskan |
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
refresh_token |
Token refresh Identity Platform untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID berakhir. |
is_new_user |
Apakah pengguna yang login dibuat oleh permintaan ini. |
display_name |
Nama tampilan pengguna yang diautentikasi. |
team_player_id |
ID pemain tim Game Center pengguna. ID unik untuk pemain dari semua game yang Anda distribusikan menggunakan akun developer. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
ID pemain game Game Center pengguna. ID unik untuk pemain game. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithIdpRequest
Pesan permintaan untuk SignInWithIdp.
| Kolom | |
|---|---|
request_uri |
Wajib. URL tempat IdP mengalihkan pengguna kembali. Ini dapat disetel ke |
post_body |
Jika pengguna login dengan respons otorisasi yang diperoleh melalui permintaan otorisasi CreateAuthUri sebelumnya, ini adalah isi callback POST HTTP dari IdP, jika ada. Atau, jika pengguna login dengan kredensial IdP yang diberikan secara manual, kredensial tersebut harus berupa formulir yang dienkode URL yang berisi kredensial (misalnya, token ID atau token akses untuk IdP OAuth 2.0) dan ID penyedia IdP yang menerbitkan kredensial. Misalnya, jika pengguna login ke penyedia Google menggunakan token ID Google, token ini harus ditetapkan ke id_token Jika pengguna login ke penyedia Facebook menggunakan token autentikasi Facebook, token ini harus ditetapkan ke id_token Jika pengguna login ke penyedia Facebook menggunakan token akses Facebook, token ini harus ditetapkan ke access_token Jika pengguna login ke penyedia Twitter menggunakan kredensial Twitter OAuth 1.0, setelan ini harus ditetapkan ke access_token |
pending_id_token |
|
return_refresh_token |
Apakah akan menampilkan token refresh OAuth dari IdP atau tidak, jika tersedia. |
session_id |
ID sesi yang ditampilkan dari panggilan CreateAuthUri sebelumnya. Kolom ini diverifikasi terhadap ID sesi tersebut untuk mencegah serangan fiksasi sesi. Wajib jika pengguna login dengan respons otorisasi dari permintaan otorisasi CreateAuthUri sebelumnya. |
delegated_project_number |
|
id_token |
Token ID Identity Platform yang valid. Jika lulus, akun pengguna di IdP akan ditautkan ke akun yang diwakili oleh token ID ini. |
return_secure_token |
Harus selalu benar. |
return_idp_credential |
Apakah akan menampilkan kredensial OAuth dari IdP atau tidak pada error berikut: |
auto_create |
|
tenant_id |
ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default. |
pending_token |
String buram dari respons SignInWithIdp sebelumnya. Jika ditetapkan, parameter ini dapat digunakan untuk mengulangi operasi login dari operasi SignInWithIdp sebelumnya. Hal ini mungkin terjadi jika pengguna perlu mengonfirmasi informasi akunnya sebagai bagian dari upaya login gabungan sebelumnya, atau melakukan penautan akun. |
SignInWithIdpResponse
Pesan respons untuk SignInWithIdp.
| Kolom | |
|---|---|
federated_id |
ID akun pengguna di IdP. Selalu ada dalam respons. |
provider_id |
ID penyedia IdP yang digunakan pengguna untuk login. Selalu ada dalam respons. |
email |
Alamat email akun pengguna di IdP. |
email_verified |
Apakah alamat email akun pengguna telah diverifikasi. |
first_name |
Nama depan untuk akun pengguna di IdP. |
full_name |
Nama lengkap untuk akun pengguna di IdP. |
last_name |
Nama belakang untuk akun pengguna di IdP. |
nick_name |
Nama panggilan untuk akun pengguna di IdP. |
language |
Preferensi bahasa untuk akun pengguna di IdP. |
time_zone |
Zona waktu untuk akun pengguna di IdP. |
photo_url |
URL foto profil pengguna di IdP. |
date_of_birth |
Tanggal lahir untuk akun pengguna di IdP. |
input_email |
|
original_email |
Alamat email utama (tingkat teratas) akun Identity Platform pengguna, jika berbeda dengan alamat email di IdP. Hanya ada jika setelan "Satu akun per alamat email" diaktifkan. |
local_id |
ID pengguna Identity Platform yang diautentikasi. Selalu ada dalam respons. |
email_recycled |
Apakah ada akun pengguna Identity Platform yang sudah ada dengan alamat email yang sama, tetapi ditautkan ke akun lain di IdP yang sama. Hanya ada jika setelan "Satu akun per alamat email" diaktifkan dan alamat email di IdP diverifikasi. |
display_name |
Nama tampilan untuk akun pengguna di IdP. |
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
context |
String buram yang ditetapkan di CreateAuthUri yang digunakan untuk mempertahankan informasi kontekstual antara permintaan autentikasi dan callback dari IdP. |
verified_provider[] |
Daftar ID penyedia yang dapat digunakan pengguna untuk login guna menyelesaikan error |
need_confirmation |
Apakah ada akun pengguna Identity Platform yang sudah ada dengan alamat email yang sama dengan akun saat ini yang login di IdP, dan alamat email akun tidak diverifikasi di IdP. Pengguna harus login ke akun Identity Platform yang ada, lalu menautkan kredensial saat ini dari IdP ke akun tersebut. Hanya ada jika setelan "Satu akun per alamat email" diaktifkan. |
oauth_access_token |
Token akses OAuth dari IdP, jika tersedia. |
oauth_refresh_token |
Token refresh OAuth 2.0 dari IdP, jika tersedia dan |
oauth_expire_in |
Jumlah detik hingga masa berlaku token akses OAuth dari IdP berakhir. |
oauth_authorization_code |
Kode otorisasi OAuth 2.0, jika tersedia. Hanya ada untuk penyedia Google. |
need_email |
|
oauth_token_secret |
Rahasia token OAuth 1.0 dari IdP, jika tersedia. Hanya ada untuk penyedia Twitter. |
refresh_token |
Token refresh Identity Platform untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID Identity Platform berakhir. |
oauth_id_token |
Token ID OpenID Connect dari IdP, jika tersedia. |
screen_name |
Nama sebutan untuk akun pengguna di IdP Twitter atau nama login untuk akun pengguna di IdP GitHub. |
raw_user_info |
Respons JSON yang di-stringify yang berisi semua data yang sesuai dengan akun pengguna di IdP. |
error_message |
Pesan error ditampilkan jika |
is_new_user |
Apakah akun Identity Platform baru dibuat untuk pengguna yang diautentikasi atau tidak. |
kind |
|
pending_token |
String buram yang dapat digunakan sebagai kredensial dari IdP yang digunakan pengguna untuk login. Token tertunda yang diperoleh di sini dapat ditetapkan dalam permintaan SignInWithIdp di masa mendatang untuk login pengguna yang sama dengan IdP lagi. |
tenant_id |
Nilai kolom |
mfa_pending_credential |
String buram yang berfungsi sebagai bukti bahwa pengguna telah berhasil lulus autentikasi faktor pertama. |
mfa_info[] |
Info tentang penyedia autentikasi multi-faktor yang diaktifkan untuk akun. Ada jika pengguna perlu menyelesaikan login menggunakan autentikasi multi-faktor. |
SignInWithPasswordRequest
Pesan permintaan untuk SignInWithPassword.
| Kolom | |
|---|---|
email |
Wajib. Email yang digunakan pengguna untuk login. Panjang email harus kurang dari 256 karakter dan dalam format |
password |
Wajib. Sandi yang diberikan pengguna untuk login ke akun. |
pending_id_token |
|
captcha_challenge |
|
captcha_response |
Token reCAPTCHA yang disediakan oleh integrasi sisi klien reCAPTCHA. reCAPTCHA Enterprise menggunakannya untuk penilaian risiko. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
instance_id |
|
delegated_project_number |
|
id_token |
|
return_secure_token |
Harus selalu benar. |
tenant_id |
ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke instance Identity Platform default dalam project. |
client_type |
Jenis klien, web, android, atau ios. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
recaptcha_version |
Versi reCAPTCHA dari token reCAPTCHA di captcha_response. |
SignInWithPasswordResponse
Pesan respons untuk SignInWithPassword.
| Kolom | |
|---|---|
kind |
|
local_id |
ID pengguna yang diautentikasi. Selalu ada dalam respons. |
email |
Email pengguna yang diautentikasi. Selalu ada dalam respons. |
display_name |
Nama tampilan pengguna yang disimpan di atribut akun. |
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
registered |
Apakah email tersebut untuk akun yang sudah ada. Selalu benar. |
profile_picture |
Foto profil pengguna yang disimpan di atribut akun. |
oauth_access_token |
Token akses OAuth2. |
oauth_expire_in |
Waktu habis masa berlaku token akses dalam detik. |
oauth_authorization_code |
|
refresh_token |
Token refresh Identity Platform untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID Identity Platform berakhir. |
mfa_pending_credential |
String buram yang berfungsi sebagai bukti bahwa pengguna telah berhasil lulus autentikasi faktor pertama. |
mfa_info[] |
Info tentang penyedia autentikasi multi-faktor yang diaktifkan untuk akun. Ada jika pengguna perlu menyelesaikan login menggunakan autentikasi multi-faktor. |
user_notifications[] |
Notifikasi peringatan untuk pengguna. |
SignInWithPhoneNumberRequest
Pesan permintaan untuk SignInWithPhoneNumber.
| Kolom | |
|---|---|
session_info |
Informasi sesi terenkripsi dari respons [sendVerificationCode][v1.accounts.sendVerificationCode]. Jika melakukan autentikasi dengan kode SMS, hal ini harus ditentukan, tetapi jika menggunakan bukti sementara, hal ini dapat tidak ditentukan. |
phone_number |
Nomor telepon pengguna yang akan digunakan untuk login. Hal ini diperlukan jika Anda menggunakan bukti sementara, yang harus cocok dengan nomor telepon yang diautentikasi dalam permintaan yang menghasilkan bukti sementara. Kolom ini diabaikan jika info sesi diteruskan. |
code |
Kode verifikasi yang dimasukkan pengguna dari SMS yang dikirim ke ponsel pengguna. |
temporary_proof |
Bukti verifikasi nomor telepon, yang diberikan dari permintaan [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] sebelumnya. Jika ini diteruskan, pemanggil juga harus meneruskan nomor telepon yang diverifikasi dalam permintaan sebelumnya ke kolom phone_number. |
verification_proof |
Jangan gunakan. |
id_token |
Token ID yang valid untuk akun Identity Platform. Jika diteruskan, permintaan ini akan menautkan nomor telepon ke pengguna yang diwakili oleh token ID ini jika nomor telepon tidak digunakan, atau akan mengautentikasi ulang pengguna jika nomor telepon sudah ditautkan ke pengguna. |
operation |
|
tenant_id |
ID tenant Identity Platform tempat pengguna login. Jika tidak ditetapkan, pengguna akan login ke project Identity Platform default. |
VerifyOp
Operasi yang diinginkan.
| Enum | |
|---|---|
VERIFY_OP_UNSPECIFIED |
Operasi tidak ditentukan. |
SIGN_UP_OR_IN |
Memverifikasi operasi untuk mendaftar/login. |
REAUTH |
Operasi verifikasi adalah untuk mengautentikasi ulang. |
UPDATE |
Verifikasi operasi untuk mengupdate. |
LINK |
Verifikasi operasinya adalah untuk menautkan. |
SignInWithPhoneNumberResponse
Pesan respons untuk SignInWithPhoneNumber.
| Kolom | |
|---|---|
id_token |
Token ID Identity Platform untuk pengguna yang diautentikasi. |
refresh_token |
Token refresh untuk pengguna yang diautentikasi. |
expires_in |
Jumlah detik hingga masa berlaku token ID habis. |
local_id |
ID pengguna yang diautentikasi. Tersedia jika autentikasi berhasil. Jika ponsel dapat diverifikasi, tetapi operasi akun tidak dapat dilakukan, bukti sementara akan ditampilkan. |
is_new_user |
Apakah pengguna yang diautentikasi dibuat oleh permintaan ini. |
temporary_proof |
Bukti verifikasi nomor telepon, yang diberikan jika autentikasi telepon berhasil tetapi operasi pengguna gagal. Hal ini terjadi saat permintaan mencoba menautkan nomor telepon ke pengguna dengan token ID atau mengautentikasi ulang dengan token ID, tetapi nomor telepon ditautkan ke pengguna lain. |
verification_proof |
Jangan gunakan. |
verification_proof_expires_in |
Jangan gunakan. |
phone_number |
Nomor telepon pengguna yang diautentikasi. Selalu ada dalam respons. |
temporary_proof_expires_in |
Jumlah detik hingga masa berlaku bukti sementara berakhir. |
SignUpRequest
Pesan permintaan untuk SignUp.
| Kolom | |
|---|---|
email |
Email yang akan ditetapkan ke pengguna yang dibuat. Panjang email harus kurang dari 256 karakter dan dalam format |
password |
Sandi yang akan ditetapkan ke pengguna yang dibuat. Sandi harus minimal 6 karakter. Jika ditetapkan, kolom |
display_name |
Nama tampilan pengguna yang akan dibuat. |
captcha_challenge |
|
captcha_response |
Token reCAPTCHA yang disediakan oleh integrasi sisi klien reCAPTCHA. reCAPTCHA Enterprise menggunakannya untuk penilaian. Wajib diisi jika reCAPTCHA Enterprise diaktifkan. |
instance_id |
|
id_token |
Token ID yang valid untuk pengguna Identity Platform. Jika ditetapkan, permintaan ini akan menautkan kredensial autentikasi ke pengguna yang diwakili oleh token ID ini. Untuk permintaan non-admin, kolom |
email_verified |
Apakah email pengguna telah diverifikasi. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
photo_url |
URL foto profil pengguna yang akan dibuat. |
disabled |
Apakah pengguna akan dinonaktifkan setelah dibuat. Akun yang dinonaktifkan tidak dapat diakses kecuali untuk permintaan yang memiliki kredensial Google OAuth2 dengan izin yang sesuai. |
local_id |
ID pengguna yang akan dibuat. ID harus unik dalam project tempat pengguna dibuat. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
phone_number |
Nomor telepon pengguna yang akan dibuat. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. |
tenant_id |
ID tenant Identity Platform untuk membuat pengguna. Jika tidak ditetapkan, pengguna akan dibuat dalam project Identity Platform default. |
target_project_id |
Project ID dari project tempat pengguna harus berada. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai. Jika tidak ditetapkan, project target akan disimpulkan dari cakupan yang terkait dengan token akses Bearer. |
mfa_info[] |
Penyedia autentikasi multi-faktor yang dapat dibuat pengguna. |
client_type |
Jenis klien: web, Android, atau iOS. Diperlukan saat mengaktifkan perlindungan reCAPTCHA Enterprise. |
recaptcha_version |
Versi reCAPTCHA dari token reCAPTCHA di captcha_response. |
MfaFactor
| Kolom | |
|---|---|
display_name |
Nama tampilan untuk opsi MFA ini, misalnya "ponsel perusahaan". |
Kolom union
|
|
phone_info |
Nomor telepon untuk menerima OTP untuk MFA. |
SignUpResponse
Pesan respons untuk SignUp.
| Kolom | |
|---|---|
kind |
|
id_token |
Token ID Identity Platform untuk pengguna yang dibuat. Kolom ini hanya ditetapkan untuk permintaan non-admin. |
display_name |
Nama tampilan pengguna yang dibuat. |
email |
Email pengguna yang dibuat. |
refresh_token |
Token refresh Identity Platform untuk pengguna yang dibuat. Kolom ini hanya ditetapkan untuk permintaan non-admin. |
expires_in |
Jumlah detik hingga masa berlaku token ID habis. |
local_id |
ID pengguna yang dibuat. Selalu ada dalam respons. |
TotpInfo
Jenis ini tidak memiliki kolom.
Informasi tentang TOTP MFA.
UploadAccountRequest
Pesan permintaan untuk UploadAccount.
| Kolom | |
|---|---|
hash_algorithm |
Wajib. Fungsi hashing yang digunakan untuk meng-hash sandi akun. Harus berupa salah satu dari berikut ini: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 |
signer_key |
Kunci penanda tangan yang digunakan untuk meng-hash sandi. Diperlukan untuk fungsi hashing berikut: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512 |
salt_separator |
Satu atau beberapa byte yang akan disisipkan di antara salt dan sandi teks biasa. Untuk keamanan yang lebih kuat, karakter ini harus berupa satu karakter yang tidak dapat dicetak. |
rounds |
Jumlah putaran yang digunakan untuk penghitungan hash. Hanya diperlukan untuk fungsi hashing berikut: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT |
memory_cost |
Biaya memori untuk penghitungan hash. Hanya diperlukan jika fungsi hashing adalah SCRYPT. |
users[] |
Daftar akun yang akan diupload. |
delegated_project_number |
|
sanity_check |
Jika benar, layanan akan melakukan daftar pemeriksaan berikut sebelum akun diupload: * Email duplikat * ID gabungan duplikat * Validasi penyedia ID gabungan Jika duplikasi ada dalam daftar akun yang akan diupload, seluruh daftar tidak akan diupload. Jika email atau ID gabungan merupakan duplikat pengguna yang sudah ada dalam project/tenant, akun tersebut tidak akan diupload, tetapi akun lainnya tidak akan terpengaruh. Jika salah, pemeriksaan ini akan dilewati. |
target_project_id |
Project ID project Identity Platform tempat akun berada. Otorisasi memerlukan izin IAM berikut pada resource
|
allow_overwrite |
Apakah akan menimpa akun yang ada di Identity Platform dengan |
cpu_mem_cost |
Parameter biaya memori CPU yang akan digunakan oleh fungsi hashing STANDARD_SCRYPT. Parameter ini, bersama dengan block_size dan cpu_mem_cost, membantu menyesuaikan resource yang diperlukan untuk melakukan hashing pada sandi, dan harus disesuaikan seiring dengan peningkatan kecepatan prosesor dan teknologi memori. |
parallelization |
Parameter biaya paralelisasi yang akan digunakan oleh fungsi hashing STANDARD_SCRYPT. Parameter ini, bersama dengan block_size dan cpu_mem_cost, membantu menyesuaikan resource yang diperlukan untuk melakukan hashing pada sandi, dan harus disesuaikan seiring dengan peningkatan kecepatan prosesor dan teknologi memori. |
block_size |
Parameter ukuran blok yang digunakan oleh fungsi hashing STANDARD_SCRYPT. Parameter ini, bersama dengan paralelisasi dan cpu_mem_cost, membantu menyesuaikan resource yang diperlukan untuk melakukan hashing sandi, dan harus disesuaikan seiring dengan peningkatan kecepatan prosesor dan teknologi memori. |
dk_len |
Panjang kunci yang diinginkan untuk fungsi hashing STANDARD_SCRYPT. Minimal harus 1. |
password_hash_order |
|
tenant_id |
ID tenant Identity Platform tempat akun berada. |
argon2_parameters |
Parameter untuk algoritma hashing Argon2. |
PasswordHashOrder
Saat melakukan hashing sandi, apakah sandi harus muncul sebelum salt atau setelahnya.
| Enum | |
|---|---|
UNSPECIFIED_ORDER |
Urutan tidak ditentukan. |
SALT_AND_PASSWORD |
Urutan adalah salt terlebih dahulu, lalu sandi. |
PASSWORD_AND_SALT |
Urutan ini adalah sandi terlebih dahulu, lalu salt. |
UploadAccountResponse
Pesan respons untuk UploadAccount.
| Kolom | |
|---|---|
kind |
|
error[] |
Info error mendetail untuk akun yang tidak dapat diupload. |
UserInfo
Informasi akun Identity Platform.
| Kolom | |
|---|---|
local_id |
Tidak dapat diubah. ID unik akun. |
email |
Alamat email akun. Panjang email harus kurang dari 256 karakter dan dalam format |
display_name |
Nama tampilan akun. Atribut akun ini tidak digunakan oleh Identity Platform. Informasi ini hanya tersedia untuk tujuan informasi. |
language |
Hanya output. Preferensi bahasa akun. Atribut akun ini tidak digunakan oleh Identity Platform. Informasi ini hanya tersedia untuk tujuan informasi. |
photo_url |
URL foto profil akun. Atribut akun ini tidak digunakan oleh Identity Platform. Informasi ini hanya tersedia untuk tujuan informasi. |
time_zone |
Hanya output. Preferensi zona waktu akun. Atribut akun ini tidak digunakan oleh Identity Platform. Informasi ini hanya tersedia untuk tujuan informasi. |
date_of_birth |
Hanya output. Tanggal lahir yang ditetapkan untuk akun. Atribut akun ini tidak digunakan oleh Identity Platform. Informasi ini hanya tersedia untuk tujuan informasi. |
password |
Sandi yang di-hash untuk akun. Hanya dapat diakses oleh permintaan yang memiliki kredensial Google OAuth2 dengan izin yang sesuai. |
salt |
Salt sandi akun. Hanya dapat diakses oleh permintaan yang memiliki kredensial Google OAuth2 dengan izin yang sesuai. |
version |
Versi sandi akun. Hanya dapat diakses oleh permintaan yang memiliki kredensial Google OAuth2 dengan izin yang sesuai. |
email_verified |
Apakah alamat email akun telah diverifikasi. |
password_updated_at |
Stempel waktu, dalam milidetik dari epoch 1970-01-01T00:00:00Z, saat sandi akun terakhir kali diperbarui. |
provider_user_info[] |
Informasi tentang pengguna seperti yang disediakan oleh berbagai Penyedia Identitas. |
valid_since |
Stempel waktu terlama, dalam detik sejak epoch, yang harus dianggap valid untuk token ID. Semua token ID yang dikeluarkan sebelum waktu ini dianggap tidak valid. |
disabled |
Apakah akun dinonaktifkan. Akun yang dinonaktifkan tidak dapat diakses kecuali untuk permintaan yang memiliki kredensial OAuth2 Google dengan izin yang sesuai. |
last_login_at |
Waktu terakhir, dalam milidetik dari epoch, akun ini login. |
created_at |
Waktu, dalam milidetik dari epoch, saat akun dibuat. |
screen_name |
Hanya output. Nama sebutan akun ini di Twitter atau nama login di GitHub. |
custom_auth |
Hanya output. Apakah akun ini telah diautentikasi menggunakan SignInWithCustomToken. |
raw_password |
Hanya input. Sandi teks biasa yang digunakan untuk memperbarui sandi akun. Kolom ini hanya digunakan sebagai input dalam permintaan. Identity Platform menggunakan hashing yang aman secara kriptografis saat mengelola sandi dan tidak akan pernah menyimpan atau mengirimkan sandi pengguna dalam teks biasa. |
phone_number |
Nomor telepon akun. |
custom_attributes |
Klaim kustom yang akan ditambahkan ke token ID yang dibuat untuk akun. Panjangnya maksimal 1.000 karakter dan dalam format JSON yang valid. |
email_link_signin |
Hanya output. Apakah akun dapat diautentikasi dengan link email. |
tenant_id |
ID tenant yang memiliki akun ini. Hanya tetapkan jika akun ini milik tenant. |
mfa_info[] |
Informasi tentang penyedia autentikasi multi-faktor yang diaktifkan untuk akun ini. |
initial_email |
Alamat email pertama yang dikaitkan dengan akun ini. Email awal akun tidak dapat diubah setelah ditetapkan dan digunakan untuk memulihkan akses ke akun ini jika hilang melalui alur RECOVER_EMAIL di GetOobCode. Harus cocok dengan addr-spec RFC 822. |
last_refresh_at |
Stempel waktu saat token ID terakhir kali dibuat untuk akun ini. |
UserNotification
Notifikasi peringatan untuk pengguna.
| Kolom | |
|---|---|
notification_code |
Enum notifikasi peringatan. Dapat digunakan untuk pelokalan. |
notification_message |
String notifikasi peringatan. Dapat digunakan sebagai penggantian. |
NotificationCode
Enum notifikasi peringatan. Dapat digunakan untuk pelokalan.
| Enum | |
|---|---|
NOTIFICATION_CODE_UNSPECIFIED |
Tidak ada notifikasi yang ditentukan. |
MISSING_LOWERCASE_CHARACTER |
Sandi tidak memiliki karakter huruf kecil. |
MISSING_UPPERCASE_CHARACTER |
Sandi tidak memiliki karakter huruf besar. |
MISSING_NUMERIC_CHARACTER |
Sandi tidak memiliki karakter numerik. |
MISSING_NON_ALPHANUMERIC_CHARACTER |
Sandi tidak memiliki karakter non-alfanumerik. |
MINIMUM_PASSWORD_LENGTH |
Sandi kurang dari panjang minimum yang diperlukan. |
MAXIMUM_PASSWORD_LENGTH |
Sandi lebih panjang dari panjang maksimum yang diwajibkan. |
VerifyIosClientRequest
Pesan permintaan untuk VerifyIosClient
| Kolom | |
|---|---|
app_token |
Token perangkat yang diperoleh klien iOS setelah mendaftar ke APN (layanan Apple Push Notification). |
is_sandbox |
Apakah token aplikasi berada di sandbox iOS. Jika salah, token aplikasi berada di lingkungan produksi. |
VerifyIosClientResponse
Pesan respons untuk VerifyIosClient.
| Kolom | |
|---|---|
receipt |
Tanda terima validasi token aplikasi yang berhasil. |
suggested_timeout |
Waktu yang disarankan yang harus ditunggu klien dalam detik untuk pengiriman notifikasi push. |