Antarmuka induk yang umum untuk Auth API dan TenantAwareAuth API.
Tanda Tangan:
export declare abstract class BaseAuth
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| createCustomToken(uid, developerClaims) | Membuat token kustom (JWT) Firebase baru yang dapat dikirim kembali ke perangkat klien untuk digunakan login dengan metode signInWithCustomToken() SDK klien. (Instance yang peka terhadap tenant juga akan menyematkan ID tenant dalam token.)Lihat Membuat Token Kustom untuk mengetahui contoh kode dan dokumentasi mendetail. |
|
| createProviderConfig(config) | Menampilkan promise yang di-resolve dengan AuthProviderConfig yang baru dibuat saat konfigurasi penyedia baru dibuat.Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP. |
|
| createSessionCookie(idToken, sessionCookieOptions) | Membuat cookie sesi Firebase baru dengan opsi yang ditentukan. String JWT yang dibuat dapat ditetapkan sebagai cookie sesi sisi server dengan kebijakan cookie kustom, dan digunakan untuk pengelolaan sesi. JWT cookie sesi akan memiliki klaim payload yang sama dengan token ID yang diberikan.Lihat Mengelola Cookie Sesi untuk mengetahui contoh kode dan dokumentasi mendetail. | |
| createUser(properti) | Membuat pengguna baru.Lihat Membuat pengguna untuk contoh kode dan dokumentasi mendetail. | |
| deleteProviderConfig(providerId) | Menghapus konfigurasi penyedia yang sesuai dengan ID penyedia yang diteruskan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP. |
|
| deleteUser(uid) | Menghapus pengguna yang ada.Lihat Menghapus pengguna untuk melihat contoh kode dan dokumentasi mendetail. | |
| deleteUsers(uid) | Menghapus pengguna yang ditentukan oleh UID tertentu.Menghapus pengguna yang tidak ada tidak akan menghasilkan error (yaitu metode ini bersifat idempoten). Pengguna yang tidak ada akan dianggap berhasil dihapus, sehingga dihitung dalam nilai DeleteUsersResult.successCount.Hanya maksimum 1.000 ID yang dapat diberikan. Jika lebih dari 1.000 ID diberikan, metode ini akan menampilkan FirebaseAuthError.Saat ini, kapasitas API ini dibatasi hingga 1 QPS di server. Jika melebihi batas ini, Anda mungkin akan mendapatkan error kuota terlampaui. Oleh karena itu, jika ingin menghapus lebih dari 1.000 pengguna, Anda mungkin perlu menambahkan penundaan untuk memastikan Anda tidak melampaui batas ini. |
|
| generateEmailVerificationLink(email, actionCodeSettings) | Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll. | |
| generatePasswordResetLink(email, actionCodeSettings) | Membuat link tindakan email out of band untuk mereset sandi pengguna. Link akan dibuat untuk pengguna dengan alamat email yang ditentukan. Objek ActionCodeSettings opsional menentukan apakah link akan ditangani oleh aplikasi seluler atau browser dan informasi status tambahan yang akan diteruskan di deep link, dll. | |
| generateSignInWithEmailLink(email, actionCodeSettings) | Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll. | |
| generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | Membuat link tindakan email out-of-band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll. | |
| getProviderConfig(providerId) | Mencari konfigurasi penyedia Auth berdasarkan ID yang diberikan. Menampilkan promise yang di-resolve dengan konfigurasi penyedia yang sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP. |
|
| getUser(uid) | Mendapatkan data pengguna untuk pengguna yang sesuai dengan uid tertentu.Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail. |
|
| getUserByEmail(email) | Mendapatkan data pengguna untuk pengguna yang sesuai dengan email tertentu.Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail. | |
| getUserByPhoneNumber(phoneNumber) | Mendapatkan data pengguna untuk pengguna yang sesuai dengan nomor telepon tertentu. Nomor telepon harus sesuai dengan spesifikasi E.164.Lihat Mengambil data pengguna untuk melihat contoh kode dan dokumentasi mendetail. | |
| getUserByProviderUid(providerId, uid) | Mendapatkan data pengguna untuk pengguna yang sesuai dengan ID penyedia tertentu.Lihat Mengambil data pengguna untuk mengetahui contoh kode dan dokumentasi mendetail. | |
| getUsers(ID) | Mendapatkan data pengguna yang sesuai dengan ID yang ditentukan.Tidak ada jaminan pengurutan; khususnya, entri ke-n dalam daftar hasil tidak dijamin sesuai dengan entri ke-n dalam daftar parameter input.Hanya maksimum 100 ID yang boleh diberikan. Jika lebih dari 100 ID diberikan, metode ini akan memunculkan FirebaseAuthError. | |
| importUsers(pengguna, opsi) | Mengimpor daftar pengguna yang disediakan ke Firebase Auth. Maksimum 1.000 pengguna diizinkan untuk diimpor satu per satu. Saat mengimpor pengguna dengan sandi, UserImportOptions harus ditentukan. Operasi ini dioptimalkan untuk impor massal dan akan mengabaikan pemeriksaan pada uid, email, dan keunikan ID lainnya yang dapat mengakibatkan duplikasi. |
|
| listProviderConfigs(opsi) | Menampilkan daftar konfigurasi penyedia yang ada dan cocok dengan filter yang diberikan. Maksimal 100 konfigurasi penyedia dapat dicantumkan sekaligus.Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP. | |
| listUsers(maxResults, pageToken) | Mengambil daftar pengguna (hanya satu batch) dengan ukuran maxResults yang dimulai dari offset seperti yang ditentukan oleh pageToken. Ini digunakan untuk mengambil semua pengguna project tertentu dalam batch.Lihat Membuat daftar semua pengguna untuk melihat contoh kode dan dokumentasi mendetail. |
|
| revokeRefreshTokens(uid) | Mencabut semua token refresh untuk pengguna yang sudah ada.API ini akan memperbarui UserRecord.tokensValidAfterTime pengguna ke UTC saat ini. Penting bahwa server tempat panggilan ini dipanggil, jamnya telah diatur dengan benar dan disinkronkan.Meskipun tindakan ini akan mencabut semua sesi untuk pengguna tertentu dan menonaktifkan token ID baru untuk sesi yang ada agar tidak dibuat, token ID yang ada dapat tetap aktif hingga masa berlaku aslinya (satu jam). Untuk memverifikasi bahwa token ID dicabut, gunakan BaseAuth.verifyIdToken() dengan checkRevoked ditetapkan ke true. |
|
| setCustomUserClaims(uid, customUserClaims) | Menetapkan klaim developer tambahan pada pengguna yang ada dan diidentifikasi oleh uid yang disediakan, yang biasanya digunakan untuk menentukan peran dan tingkat akses pengguna. Klaim ini harus diterapkan ke semua perangkat tempat pengguna sudah login (setelah masa berlaku token habis atau saat refresh token dipaksa) dan saat pengguna login lagi. Jika nama klaim OIDC yang dicadangkan digunakan (sub, iat, iss, dll.), error akan muncul. Atribut ini ditetapkan pada JWT token ID pengguna terautentikasi.Lihat Menentukan peran dan tingkat akses pengguna untuk contoh kode dan dokumentasi mendetail. |
|
| updateProviderConfig(providerId, updatedConfig) | Menampilkan promise yang di-resolve dengan AuthProviderConfig yang diperbarui sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP. |
|
| updateUser(uid, properti) | Memperbarui pengguna yang ada.Lihat Memperbarui pengguna untuk contoh kode dan dokumentasi mendetail. | |
| verifyIdToken(idToken, checkRevoked) | Memverifikasi token ID Firebase (JWT). Jika token valid, promise akan dipenuhi dengan klaim yang didekode; jika tidak, promise akan ditolak.Jika checkRevoked ditetapkan ke true, pertama-tama akan memverifikasi apakah pengguna yang sesuai dinonaktifkan. Jika ya, error auth/user-disabled akan muncul. Jika tidak, periksa apakah sesi yang sesuai dengan token ID dicabut. Jika sesi pengguna yang sesuai dibatalkan, error auth/id-token-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak akan diterapkan.Lihat Memverifikasi Token ID untuk mengetahui contoh kode dan dokumentasi mendetail. |
|
| verifySessionCookie(sessionCookie, checkDicabut) | Memverifikasi cookie sesi Firebase. Menampilkan Promise dengan klaim cookie. Menolak promise jika cookie tidak dapat diverifikasi.Jika checkRevoked ditetapkan ke true, pertama-tama verifikasi apakah pengguna terkait dinonaktifkan: Jika ya, error auth/user-disabled akan ditampilkan. Jika tidak, verifikasi apakah sesi yang sesuai dengan cookie sesi telah dicabut. Jika sesi pengguna yang sesuai dibatalkan, error auth/session-cookie-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak akan dilakukan.Lihat Memverifikasi Cookie Sesi untuk mengetahui contoh kode dan dokumentasi mendetail |
BaseAuth.createCustomToken()
Membuat token kustom (JWT) Firebase baru yang dapat dikirim kembali ke perangkat klien untuk digunakan login dengan metode signInWithCustomToken() SDK klien. (Instance yang peka terhadap tenant juga akan menyematkan ID tenant dalam token.)
Lihat Membuat Token Kustom untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang akan digunakan sebagai subjek token kustom. |
| Klaim developer | objek | Klaim tambahan opsional yang akan disertakan dalam payload token kustom. |
Hasil:
Promise<string>
Promise dipenuhi dengan token kustom untuk uid dan payload yang disediakan.
BaseAuth.createProviderConfig()
Menampilkan promise yang di-resolve dengan AuthProviderConfig yang baru dibuat saat konfigurasi penyedia baru dibuat.
Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Tanda Tangan:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| config | AuthProviderConfig | Konfigurasi penyedia yang akan dibuat. |
Hasil:
Promise<AuthProviderConfig>
Promise yang di-resolve dengan konfigurasi penyedia yang dibuat.
BaseAuth.createSessionCookie()
Membuat cookie sesi Firebase baru dengan opsi yang ditentukan. String JWT yang dibuat dapat ditetapkan sebagai cookie sesi sisi server dengan kebijakan cookie kustom, dan digunakan untuk pengelolaan sesi. JWT cookie sesi akan memiliki klaim payload yang sama dengan token ID yang diberikan.
Lihat Mengelola Cookie Sesi untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| idToken | string | Token ID Firebase yang akan ditukar dengan cookie sesi. |
| sessionCookieOptions | SessionCookieOptions | Opsi cookie sesi yang menyertakan durasi sesi kustom. |
Hasil:
Promise<string>
Promise yang di-resolve jika berhasil dengan cookie sesi yang dibuat.
BaseAuth.createUser()
Membuat pengguna baru.
Lihat Membuat pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
createUser(properties: CreateRequest): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| properties | CreateRequest | Properti yang akan ditetapkan pada data pengguna baru yang akan dibuat. |
Hasil:
Promise<UserRecord>
Promise dipenuhi dengan data pengguna yang sesuai dengan pengguna yang baru dibuat.
BaseAuth.deleteProviderConfig()
Menghapus konfigurasi penyedia yang sesuai dengan ID penyedia yang diteruskan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.
Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Tanda Tangan:
deleteProviderConfig(providerId: string): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| IDpenyedia | string | ID penyedia yang sesuai dengan konfigurasi penyedia yang akan dihapus. |
Hasil:
Promise<void>
Promise yang akan selesai setelah selesai.
BaseAuth.deleteUser()
Menghapus pengguna yang ada.
Lihat Menghapus pengguna untuk melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
deleteUser(uid: string): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang sesuai dengan pengguna yang akan dihapus. |
Hasil:
Promise<void>
Promise kosong yang terpenuhi setelah pengguna dihapus.
BaseAuth.deleteUsers()
Menghapus pengguna yang ditentukan oleh UID tertentu.
Menghapus pengguna yang tidak ada tidak akan menghasilkan error (yaitu metode ini idempoten.) Pengguna yang tidak ada akan dianggap berhasil dihapus, sehingga dihitung dalam nilai DeleteUsersResult.successCount.
Maksimum hanya 1.000 ID yang dapat diberikan. Jika lebih dari 1.000 ID diberikan, metode ini akan memunculkan FirebaseAuthError.
Saat ini, API ini dibatasi kapasitasnya di server hingga 1 QPS. Jika melebihi batas ini, Anda mungkin akan mendapatkan error kuota terlampaui. Oleh karena itu, jika ingin menghapus lebih dari 1.000 pengguna, Anda mungkin perlu menambahkan penundaan untuk memastikan Anda tidak melampaui batas ini.
Tanda Tangan:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| Uid | string[] | uids yang sesuai dengan pengguna yang akan dihapus. |
Hasil:
Promise<DeleteUsersResult>
Promise yang me-resolve ke jumlah total penghapusan yang berhasil/gagal, serta array error yang berkaitan dengan penghapusan yang gagal.
BaseAuth.generateEmailVerificationLink()
Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll.
Tanda Tangan:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Akun email yang akan diverifikasi. | |
| setelanKodetindakan | ActionCodeSettings | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai parameter "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika diinstal. Jika actionCodeSettings tidak ditetapkan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus merupakan bagian dari domain yang diizinkan oleh developer di konsol. Jika tidak, error akan ditampilkan. Pengalihan aplikasi seluler hanya berlaku jika developer mengonfigurasi dan menyetujui persyaratan layanan Firebase Dynamic Links. Nama paket Android dan ID paket iOS hanya akan dipatuhi jika dikonfigurasi dalam project Firebase Auth yang sama. |
Hasil:
Promise<string>
Promise yang di-resolve dengan link yang dihasilkan.
Contoh
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generatePasswordResetLink()
Membuat link tindakan email out of band untuk mereset sandi pengguna. Link akan dibuat untuk pengguna dengan alamat email yang ditentukan. Objek ActionCodeSettings opsional menentukan apakah link akan ditangani oleh aplikasi seluler atau browser dan informasi status tambahan yang akan diteruskan di deep link, dll.
Tanda Tangan:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Alamat email pengguna yang sandinya akan direset. | |
| setelanKodetindakan | ActionCodeSettings | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai parameter "continueUrl" di link reset sandi. Halaman landing reset sandi default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika terinstal. Jika actionCodeSettings tidak ditetapkan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus merupakan bagian dari domain yang diizinkan oleh developer di konsol. Jika tidak, error akan ditampilkan. Pengalihan aplikasi seluler hanya berlaku jika developer mengonfigurasi dan menyetujui persyaratan layanan Firebase Dynamic Links. Nama paket Android dan ID paket iOS hanya akan dipatuhi jika dikonfigurasi dalam project Firebase Auth yang sama. |
Hasil:
Promise<string>
Promise yang di-resolve dengan link yang dihasilkan.
Contoh
var actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generatePasswordResetLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateSignInWithEmailLink()
Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll.
Tanda Tangan:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Akun email yang akan diverifikasi. | |
| setelanKodetindakan | ActionCodeSettings | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai parameter "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika diinstal. Jika actionCodeSettings tidak ditetapkan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus merupakan bagian dari domain yang diizinkan oleh developer di konsol. Jika tidak, error akan ditampilkan. Pengalihan aplikasi seluler hanya berlaku jika developer mengonfigurasi dan menyetujui persyaratan layanan Firebase Dynamic Links. Nama paket Android dan ID paket iOS hanya akan dipatuhi jika dikonfigurasi dalam project Firebase Auth yang sama. |
Hasil:
Promise<string>
Promise yang di-resolve dengan link yang dihasilkan.
Contoh
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateVerifyAndChangeEmailLink()
Membuat link tindakan email out-of-band untuk memverifikasi kepemilikan pengguna atas email tertentu. Objek ActionCodeSettings yang diberikan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan di deep link, dll.
Tanda Tangan:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Akun email saat ini. | |
| Emailbaru | string | Alamat email yang menerima pembaruan akun. |
| setelanKodetindakan | ActionCodeSettings | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai parameter "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika diinstal. Jika actionCodeSettings tidak ditetapkan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus merupakan milik domain yang diberi otorisasi di konsol. Jika tidak, error akan ditampilkan. Pengalihan aplikasi seluler hanya berlaku jika developer mengonfigurasi dan menyetujui persyaratan layanan Firebase Dynamic Links. Nama paket Android dan ID paket iOS hanya akan dipatuhi jika dikonfigurasi dalam project Firebase Auth yang sama. |
Hasil:
Promise<string>
Promise yang di-resolve dengan link yang dihasilkan.
BaseAuth.getProviderConfig()
Mencari konfigurasi penyedia Auth berdasarkan ID yang diberikan. Menampilkan promise yang di-resolve dengan konfigurasi penyedia yang sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.
Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Tanda Tangan:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| IDpenyedia | string | ID penyedia yang sesuai dengan konfigurasi penyedia yang akan ditampilkan. |
Hasil:
Promise<AuthProviderConfig>
Promise yang di-resolve dengan konfigurasi yang sesuai dengan ID yang diberikan.
BaseAuth.getUser()
Mendapatkan data pengguna untuk pengguna yang sesuai dengan uid tertentu.
Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUser(uid: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang sesuai dengan pengguna yang datanya akan diambil. |
Hasil:
Promise<UserRecord>
Janji yang dipenuhi dengan data pengguna yang sesuai dengan uid yang diberikan.
BaseAuth.getUserByEmail()
Mendapatkan data pengguna untuk pengguna yang sesuai dengan email tertentu.
Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUserByEmail(email: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Email yang sesuai dengan pengguna yang datanya akan diambil. |
Hasil:
Promise<UserRecord>
Janji yang dipenuhi dengan data pengguna yang sesuai dengan email yang diberikan.
BaseAuth.getUserByPhoneNumber()
Mendapatkan data pengguna untuk pengguna yang sesuai dengan nomor telepon tertentu. Nomor telepon harus sesuai dengan spesifikasi E.164.
Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| nomortelepon | string | Nomor telepon yang sesuai dengan pengguna yang datanya akan diambil. |
Hasil:
Promise<UserRecord>
Janji yang dipenuhi dengan data pengguna yang sesuai dengan nomor telepon yang diberikan.
BaseAuth.getUserByProviderUid()
Mendapatkan data pengguna untuk pengguna yang sesuai dengan ID penyedia tertentu.
Lihat Mengambil data pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| IDpenyedia | string | ID penyedia, misalnya, "google.com" untuk penyedia Google. |
| uid | string | ID pengguna untuk penyedia tertentu. |
Hasil:
Promise<UserRecord>
Promise dipenuhi dengan data pengguna yang sesuai dengan ID penyedia yang diberikan.
BaseAuth.getUsers()
Mendapatkan data pengguna yang sesuai dengan ID yang ditentukan.
Tidak ada jaminan pengurutan; khususnya, entri ke-n dalam daftar hasil tidak dijamin sesuai dengan entri ke-n dalam daftar parameter input.
Maksimum hanya 100 ID yang dapat diberikan. Jika lebih dari 100 ID diberikan, metode ini akan memunculkan FirebaseAuthError.
Tanda Tangan:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| ID | IDPengguna[] | ID yang digunakan untuk menunjukkan data pengguna mana yang harus ditampilkan. Tidak boleh lebih dari 100 entri. |
Hasil:
Promise<GetUsersResult>
Promise yang di-resolve ke kumpulan data pengguna yang sesuai.
Pengecualian
FirebaseAuthError Jika ada ID yang tidak valid atau jika ada lebih dari 100 ID yang ditentukan.
BaseAuth.importUsers()
Mengimpor daftar pengguna yang disediakan ke Firebase Auth. Maksimum 1.000 pengguna diizinkan untuk diimpor satu per satu. Saat mengimpor pengguna dengan sandi, UserImportOptions harus ditentukan. Operasi ini dioptimalkan untuk impor massal dan akan mengabaikan pemeriksaan pada uid, email, dan keunikan ID lainnya yang dapat mengakibatkan duplikasi.
Tanda Tangan:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| pengguna | UserImportRecord[] | Daftar record pengguna yang akan diimpor ke Firebase Auth. |
| opsi | UserImportOptions | Opsi impor pengguna, diperlukan jika pengguna yang diberikan menyertakan kredensial sandi. |
Hasil:
Janji<UserImportResult>
Promise yang di-resolve saat operasi selesai dengan hasil impor. Ini mencakup jumlah impor yang berhasil, jumlah impor yang gagal, dan error terkait.
BaseAuth.listProviderConfigs()
Menampilkan daftar konfigurasi penyedia yang ada dan cocok dengan filter yang diberikan. Maksimal 100 konfigurasi penyedia yang dapat dicantumkan sekaligus.
Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Tanda Tangan:
listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| opsi | AuthProviderConfigFilter | Filter konfigurasi penyedia yang akan diterapkan. |
Hasil:
Promise<ListProviderConfigResults>
Promise yang di-resolve dengan daftar konfigurasi penyedia yang memenuhi persyaratan filter.
BaseAuth.listUsers()
Mengambil daftar pengguna (hanya satu batch) dengan ukuran maxResults yang dimulai dari offset seperti yang ditentukan oleh pageToken. Ini digunakan untuk mengambil semua pengguna project tertentu dalam batch.
Lihat Membuat daftar semua pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| maxResults | angka | Ukuran halaman, 1.000 jika tidak ditentukan. Batas ini juga merupakan batas maksimum yang diizinkan. |
| pageToken | string | Token halaman berikutnya. Jika tidak ditentukan, pengguna akan menampilkan pengguna yang dimulai tanpa offset apa pun. |
Hasil:
Promise<ListUsersResult>
Promise yang di-resolve dengan batch pengguna yang didownload saat ini dan token halaman berikutnya.
BaseAuth.revokeRefreshTokens()
Mencabut semua token refresh untuk pengguna yang ada.
API ini akan memperbarui UserRecord.tokensValidAfterTime pengguna ke UTC saat ini. Penting bahwa server tempat panggilan ini dipanggil, jamnya disetel dengan benar dan disinkronkan.
Meskipun tindakan ini akan mencabut semua sesi untuk pengguna tertentu dan menonaktifkan token ID baru untuk sesi yang ada agar tidak dibuat, token ID yang ada dapat tetap aktif hingga masa berlaku aslinya (satu jam). Untuk memverifikasi bahwa token ID dicabut, gunakan BaseAuth.verifyIdToken() dengan checkRevoked ditetapkan ke true.
Tanda Tangan:
revokeRefreshTokens(uid: string): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang sesuai dengan pengguna yang token refresh-nya akan dicabut. |
Hasil:
Promise<void>
Promise kosong terpenuhi setelah token refresh pengguna dicabut.
BaseAuth.setCustomUserClaims()
Menetapkan klaim developer tambahan pada pengguna yang ada dan diidentifikasi dengan uid yang disediakan, yang biasanya digunakan untuk menentukan peran dan tingkat akses pengguna. Klaim ini harus diterapkan ke semua perangkat tempat pengguna sudah login (setelah masa berlaku token habis atau saat refresh token dipaksa) dan saat pengguna login lagi. Jika nama klaim OIDC yang dicadangkan digunakan (sub, iat, iss, dll.), error akan muncul. Atribut ini ditetapkan pada JWT token ID pengguna yang diautentikasi.
Lihat Menentukan peran dan tingkat akses pengguna untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid pengguna yang akan diedit. |
| CustomUserClaims | objek | null | Developer mengklaim telah menyiapkan. Jika null diteruskan, klaim kustom yang ada akan dihapus. Error akan muncul jika Anda meneruskan payload klaim kustom yang lebih besar dari 1.000 byte. Klaim kustom ditambahkan ke token ID pengguna yang dikirim pada setiap permintaan terautentikasi. Untuk atribut pengguna yang tidak terkait dengan akses, gunakan database atau sistem penyimpanan terpisah lainnya. |
Hasil:
Promise<void>
Promise yang akan di-resolve saat operasi berhasil diselesaikan.
BaseAuth.updateProviderConfig()
Menampilkan promise yang di-resolve dengan AuthProviderConfig yang diperbarui sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan muncul.
Dukungan penyedia SAML dan OIDC memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.
Tanda Tangan:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| IDpenyedia | string | ID penyedia yang sesuai dengan konfigurasi penyedia yang akan diperbarui. |
| updateConfig | UpdateAuthProviderRequest | Konfigurasi yang diperbarui. |
Hasil:
Promise<AuthProviderConfig>
Promise yang di-resolve dengan konfigurasi penyedia yang diperbarui.
BaseAuth.updateUser()
Memperbarui pengguna yang sudah ada.
Lihat Memperbarui pengguna untuk contoh kode dan dokumentasi mendetail.
Tanda Tangan:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang sesuai dengan pengguna untuk diperbarui. |
| properties | UpdateRequest | Properti yang akan diperbarui pada pengguna yang disediakan. |
Hasil:
Promise<UserRecord>
Janji yang dipenuhi dengan data pengguna yang diperbarui.
BaseAuth.verifyIdToken()
Memverifikasi token ID Firebase (JWT). Jika token valid, promise akan dipenuhi dengan klaim token yang didekode; jika tidak, promise akan ditolak.
Jika checkRevoked disetel ke benar (true), pertama-tama verifikasi apakah pengguna yang sesuai dinonaktifkan. Jika ya, error auth/user-disabled akan muncul. Jika tidak, periksa apakah sesi yang sesuai dengan token ID dicabut. Jika sesi pengguna yang sesuai dibatalkan, error auth/id-token-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak akan diterapkan.
Lihat Memverifikasi Token ID untuk mengetahui contoh kode dan dokumentasi mendetail.
Tanda Tangan:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| idToken | string | Token ID untuk diverifikasi. |
| centang Dicabut | boolean | Apakah akan memeriksa apakah token ID telah dicabut. Hal ini memerlukan permintaan tambahan ke backend Firebase Auth untuk memeriksa waktu tokensValidAfterTime bagi pengguna yang sesuai. Jika tidak ditentukan, pemeriksaan tambahan ini tidak akan diterapkan. |
Hasil:
Promise<DecodedIdToken>
Promise dipenuhi dengan klaim yang didekode jika token ID valid; jika tidak, promise yang ditolak.
BaseAuth.verifySessionCookie()
Memverifikasi cookie sesi Firebase. Menampilkan Promise dengan klaim cookie. Menolak promise jika cookie tidak dapat diverifikasi.
Jika checkRevoked disetel ke benar (true), pertama-tama verifikasi apakah pengguna yang sesuai dinonaktifkan: Jika ya, error auth/user-disabled akan ditampilkan. Jika tidak, verifikasi apakah sesi yang sesuai dengan cookie sesi telah dicabut. Jika sesi pengguna yang sesuai dibatalkan, error auth/session-cookie-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak dilakukan.
Lihat Memverifikasi Cookie Sesi untuk mengetahui contoh kode dan dokumentasi mendetail
Tanda Tangan:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| Kuki sesi | string | Cookie sesi yang akan diverifikasi. |
| centang Dicabut | boolean |
Hasil:
Promise<DecodedIdToken>
Janji yang dipenuhi dengan klaim yang didekode cookie sesi jika cookie sesi valid; jika tidak, promise yang ditolak.