Method: projects.accounts

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.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
targetProjectId

string

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.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "email": string,
  "password": string,
  "displayName": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "idToken": string,
  "emailVerified": boolean,
  "photoUrl": string,
  "disabled": boolean,
  "localId": string,
  "phoneNumber": string,
  "tenantId": string,
  "mfaInfo": [
    {
      object (MfaFactor)
    }
  ],
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
Kolom
email

string

Email yang akan ditetapkan ke pengguna yang dibuat. Panjang email harus kurang dari 256 karakter dan dalam format name@domain.tld. Email juga harus cocok dengan produksi addr-spec RFC 822. Pengguna anonim akan dibuat jika tidak diberikan.

password

string

Sandi yang akan ditetapkan ke pengguna yang dibuat. Sandi harus minimal 6 karakter. Jika ditetapkan, kolom email juga harus ditetapkan.

displayName

string

Nama tampilan pengguna yang akan dibuat.

captchaChallenge
(deprecated)

string

captchaResponse

string

Token reCAPTCHA yang disediakan oleh integrasi sisi klien reCAPTCHA. reCAPTCHA Enterprise menggunakannya untuk penilaian. Wajib diisi jika reCAPTCHA Enterprise diaktifkan.

instanceId
(deprecated)

string

idToken

string

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 dan password harus ditetapkan. Untuk permintaan admin, localId tidak boleh ditetapkan.

emailVerified

boolean

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

photoUrl

string

URL foto profil pengguna yang akan dibuat.

disabled

boolean

Apakah pengguna akan dinonaktifkan setelah dibuat. Akun yang dinonaktifkan tidak dapat diakses kecuali untuk permintaan yang memiliki kredensial Google OAuth2 dengan izin yang sesuai.

localId

string

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.

phoneNumber

string

Nomor telepon pengguna yang akan dibuat. Untuk menentukan kolom ini, Anda memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.

tenantId

string

ID tenant Identity Platform untuk membuat pengguna. Jika tidak ditetapkan, pengguna akan dibuat dalam project Identity Platform default.

mfaInfo[]

object (MfaFactor)

Penyedia autentikasi multi-faktor yang dapat dibuat pengguna.

clientType

enum (ClientType)

Jenis klien: web, Android, atau iOS. Diperlukan saat mengaktifkan perlindungan reCAPTCHA Enterprise.

recaptchaVersion

enum (RecaptchaVersion)

Versi reCAPTCHA dari token reCAPTCHA di captchaResponse.

Isi respons

Jika berhasil, isi respons akan berisi instance SignUpResponse.

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.