Method: accounts.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.

Permintaan HTTP

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithCustomToken

URL menggunakan sintaks gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "token": string,
  "instanceId": string,
  "returnSecureToken": boolean,
  "delegatedProjectNumber": string,
  "tenantId": string
}
Kolom
token

string

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".
instanceId
(deprecated)

string
returnSecureToken

boolean

Harus selalu benar.
delegatedProjectNumber
(deprecated)

string (int64 format)
tenantId

string

ID tenant Identity Platform tempat pengguna login. Jika ada, ID harus cocok dengan tenantId dalam token.

Isi respons

Pesan respons untuk accounts.signInWithCustomToken.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "kind": string,
  "idToken": string,
  "refreshToken": string,
  "expiresIn": string,
  "isNewUser": boolean
}
Kolom
kind
(deprecated)

string
idToken

string

Token ID Identity Platform untuk pengguna yang diautentikasi.
refreshToken

string

Token refresh Identity Platform untuk pengguna yang diautentikasi.
expiresIn

string (int64 format)

Jumlah detik hingga masa berlaku token ID berakhir.
isNewUser

boolean

Apakah pengguna yang diautentikasi dibuat oleh permintaan ini.

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.