Method: projects.tenants.accounts.update

Memperbarui informasi terkait akun untuk pengguna yang ditentukan dengan menetapkan kolom tertentu atau menerapkan kode tindakan. Permintaan dari administrator dan pengguna akhir didukung.

Permintaan HTTP

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:update

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
targetProjectId

string

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 targetProjectId yang ditentukan:

  • firebaseauth.users.update
tenantId

string

ID tenant tenant Identity Platform tempat akun berada. Permintaan dari pengguna akhir harus meneruskan token ID Identity Platform, bukan menetapkan kolom ini.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "idToken": string,
  "localId": string,
  "displayName": string,
  "email": string,
  "password": string,
  "provider": [
    string
  ],
  "oobCode": string,
  "emailVerified": boolean,
  "upgradeToFederatedLogin": boolean,
  "captchaChallenge": string,
  "captchaResponse": string,
  "validSince": string,
  "disableUser": boolean,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "photoUrl": string,
  "deleteAttribute": [
    enum (UserAttributeName)
  ],
  "returnSecureToken": boolean,
  "deleteProvider": [
    string
  ],
  "lastLoginAt": string,
  "createdAt": string,
  "phoneNumber": string,
  "customAttributes": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
Kolom
idToken

string

Token ID Identity Platform yang valid. Wajib diisi saat mencoba mengubah informasi terkait pengguna.
localId

string

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.
displayName

string

Nama tampilan baru pengguna yang akan diperbarui di atribut akun. Panjang nama tampilan harus kurang dari atau sama dengan 256 karakter.
email

string

Email baru pengguna yang akan diperbarui di atribut akun. Panjang email harus kurang dari 256 karakter dan dalam format name@domain.tld. Email juga harus cocok dengan produksi addr-spec RFC 822. Jika perlindungan enumerasi email diaktifkan, email tidak dapat diubah oleh pengguna tanpa memverifikasi email terlebih dahulu, tetapi dapat diubah oleh administrator.
password

string

Sandi baru pengguna yang akan diperbarui di atribut akun. Panjang sandi minimal harus 6 karakter.
provider[]

string

Penyedia Identitas yang akan dikaitkan dengan akun.
oobCode

string

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
emailVerified

boolean

Apakah email pengguna telah diverifikasi. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.
upgradeToFederatedLogin

boolean

Apakah akun harus dibatasi agar hanya menggunakan login gabungan.
captchaChallenge
(deprecated)

string
captchaResponse

string

Respons dari tantangan reCaptcha. Hal ini diperlukan saat sistem mendeteksi kemungkinan aktivitas penyalahgunaan.
validSince

string (int64 format)

Menentukan stempel waktu minimum dalam detik agar token ID Identity Platform dianggap valid.
disableUser

boolean

Jika benar, akun akan ditandai sebagai dinonaktifkan, yang berarti pengguna tidak akan dapat login lagi.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
photoUrl

string

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

enum (UserAttributeName)
returnSecureToken

boolean

Apakah akan menampilkan ID dan token refresh atau tidak. Harus selalu benar.
deleteProvider[]

string

Penyedia Identitas yang akan dibatalkan tautannya dari akun pengguna.
lastLoginAt

string (int64 format)

Stempel waktu dalam milidetik saat akun terakhir kali login.
createdAt

string (int64 format)

Stempel waktu dalam milidetik saat akun dibuat.
phoneNumber

string

Nomor telepon yang akan diperbarui di atribut akun.
customAttributes

string

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.
mfa

object (MfaInfo)

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.

Isi respons

Jika berhasil, isi respons akan berisi instance SetAccountInfoResponse.

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.