Antarmuka induk umum untuk API Auth dan TenantAwareAuth.
Tanda Tangan:
export declare abstract class BaseAuth
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| createCustomToken(uid, developerKlaim) | Membuat token kustom Firebase (JWT) baru yang dapat dikirim kembali ke perangkat klien untuk digunakan login dengan SDK klien Metode signInWithCustomToken(). (Instance tentant-aware juga akan menyematkan ID tenant di 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 melihat 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 ditampilkan.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 sudah ada.Lihat Menghapus pengguna untuk melihat contoh kode dan dokumentasi mendetail. | |
| deleteUsers(uid) | Menghapus pengguna yang ditentukan oleh uid yang ditentukan.Menghapus pengguna yang tidak ada tidak akan menimbulkan error (yaitu metode ini idempoten.) Pengguna yang tidak ada dianggap berhasil dihapus, dan karenanya 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 di server hingga 1 QPS. Jika melebihi batas ini, Anda mungkin akan mengalami 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 yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam 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 dalam deep link, dll. | |
| generateSignInWithEmailLink(email, actionCodeSettings) | Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam deep link, dll. | |
| generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) | Membuat link tindakan email out-of-band untuk memverifikasi kepemilikan pengguna atas email yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam 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 ditampilkan.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 melihat 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 melihat contoh kode dan dokumentasi mendetail. | |
| getUsers(ID) | Mendapatkan data pengguna yang sesuai dengan ID yang ditentukan.Tidak ada jaminan pemesanan; khususnya, entri ke-n dalam daftar hasil tidak dijamin sesuai dengan entri ke-n dalam daftar parameter input.Hanya maksimum 100 ID yang dapat diberikan. Jika lebih dari 100 ID diberikan, metode ini akan menampilkan FirebaseAuthError. | |
| importUsers(pengguna, opsi) | Mengimpor daftar pengguna yang disediakan ke Firebase Auth. Maksimum 1.000 pengguna yang 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, serta keunikan ID lainnya yang dapat mengakibatkan duplikasi. |
|
| listProviderConfigs(opsi) | Menampilkan daftar konfigurasi penyedia yang ada yang 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 (khusus batch tunggal) dengan ukuran maxResults dimulai dari offset seperti yang ditentukan oleh pageToken. Link 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 ada.API ini akan mengupdate UserRecord.tokensValidAfterTime pengguna ke UTC saat ini. Penting bahwa server yang melakukan pemanggilan ini menetapkan jamnya dengan benar dan disinkronkan.Meskipun tindakan ini akan mencabut semua sesi untuk pengguna tertentu dan menonaktifkan setiap token ID baru untuk sesi yang ada agar tidak dicetak, token ID yang ada dapat tetap aktif hingga masa berlakunya habis (satu jam). Untuk memverifikasi bahwa token ID dicabut, gunakan BaseAuth.verifyIdToken() jika checkRevoked disetel ke benar (true). |
|
| setCustomUser Claimss(uid, customUserKlaims) | Menetapkan klaim developer tambahan pada pengguna lama yang diidentifikasi oleh uid yang disediakan, yang biasanya digunakan untuk menentukan peran dan tingkat akses pengguna. Klaim ini akan diterapkan ke semua perangkat tempat pengguna login (setelah masa berlaku token habis atau saat token refresh dipaksa), dan saat pengguna login lagi. Jika nama klaim OIDC yang dicadangkan digunakan (sub, iat, iss, dll.), error akan ditampilkan. Nilai kunci ditetapkan pada JWT token ID pengguna yang diautentikasi.Lihat Menentukan peran pengguna dan tingkat akses untuk mengetahui contoh kode dan dokumentasi mendetail. |
|
| updateProviderConfig(providerId, updatedConfig) | Menampilkan promise yang di-resolve dengan AuthProviderConfig yang diupdate yang sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan ditampilkan.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 melihat contoh kode dan dokumentasi mendetail. | |
| verifyIdToken(idToken, checkAuthd) | Memverifikasi token ID Firebase (JWT). Jika token valid, promise akan terpenuhi dengan klaim token yang didekode; jika tidak, promise akan ditolak.Jika checkRevoked ditetapkan ke 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 token ID telah dicabut. Jika sesi pengguna yang sesuai tidak valid, error auth/id-token-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak diterapkan.Lihat Memverifikasi Token ID untuk melihat contoh kode dan dokumentasi mendetail. |
|
| verifySessionCookie(sessionCookie, checkCabut) | Memverifikasi cookie sesi Firebase. Menampilkan Promise dengan klaim cookie. Menolak promise jika cookie tidak dapat diverifikasi.Jika checkRevoked ditetapkan ke true, pertama-tama memverifikasi apakah pengguna yang sesuai telah 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 tidak valid, error auth/session-cookie-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak dilakukan.Lihat Verifikasi Cookie Sesi untuk contoh kode dan dokumentasi mendetail |
BaseAuth.createCustomToken()
Membuat token kustom Firebase (JWT) baru yang dapat dikirim kembali ke perangkat klien untuk digunakan login dengan SDK klien Metode signInWithCustomToken(). (Instance tentant-aware juga akan menyematkan ID tenant di token.)
Lihat Membuat Token Khusus untuk contoh kode dan dokumentasi terperinci.
Tanda Tangan:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid yang akan digunakan sebagai subjek token kustom. |
| DeveloperKlaim | objek | Klaim tambahan opsional untuk disertakan dalam payload token kustom. |
Hasil:
Promise<string>
Promise dijalankan 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 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 ditukarkan dengan cookie sesi. |
| sessionCookieOptions | SessionCookieOptions | Opsi cookie sesi yang mencakup durasi sesi kustom. |
Hasil:
Promise<string>
Janji yang memberikan keberhasilan dengan cookie sesi yang dibuat.
BaseAuth.createUser()
Membuat pengguna baru.
Lihat Membuat pengguna untuk melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
createUser(properties: CreateRequest): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| properti | Buat Permintaan | Properti yang akan ditetapkan pada kumpulan data pengguna baru yang akan dibuat. |
Hasil:
Janji<UserRecord>
Promise dijalankan 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 ditampilkan.
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 |
|---|---|---|
| providerId | string | ID penyedia yang sesuai dengan konfigurasi penyedia yang akan dihapus. |
Hasil:
Janji<void>
Janji yang akan teratasi setelah selesai.
BaseAuth.deleteUser()
Menghapus pengguna yang sudah ada.
Buka 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:
Janji<void>
Promise kosong terpenuhi setelah pengguna dihapus.
BaseAuth.deleteUsers()
Menghapus pengguna yang ditentukan oleh UID yang diberikan.
Menghapus pengguna yang tidak ada tidak akan menghasilkan error (yaitu, metode ini bersifat idempoten.) Pengguna yang tidak ada dianggap berhasil dihapus, dan karena itu 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 di server hingga 1 QPS. Jika melebihi batas ini, Anda mungkin akan mengalami 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 | {i>string<i}[] | 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 terkait dengan penghapusan yang gagal.
BaseAuth.generateEmailVerificationLink()
Membuat link tindakan email out of band untuk memverifikasi kepemilikan pengguna atas email yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam deep link, dll.
Tanda Tangan:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Akun email yang akan diverifikasi. | |
| {i>actionCodeSettings<i} | SetelanKodeTindakan | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika sudah diinstal. Jika actionCodeSettings tidak ditentukan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus milik 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 akan diterapkan hanya 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 dalam deep link, dll.
Tanda Tangan:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Alamat email pengguna yang sandinya akan direset. | |
| {i>actionCodeSettings<i} | SetelanKodeTindakan | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai "continueUrl" di link reset sandi. Halaman landing reset sandi default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika sudah diinstal. Jika actionCodeSettings tidak ditentukan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus milik 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 akan diterapkan hanya 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 yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam deep link, dll.
Tanda Tangan:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| string | Akun email yang akan diverifikasi. | |
| {i>actionCodeSettings<i} | SetelanKodeTindakan | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika sudah diinstal. Jika actionCodeSettings tidak ditentukan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus milik 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 akan diterapkan hanya 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 yang ditentukan. Objek ActionCodeSettings yang disediakan sebagai argumen untuk metode ini menentukan apakah link akan ditangani oleh aplikasi seluler atau browser bersama dengan informasi status tambahan yang akan diteruskan dalam 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 menjadi tujuan pembaruan akun. |
| {i>actionCodeSettings<i} | SetelanKodeTindakan | Setelan kode tindakan. Jika ditentukan, status/continue URL ditetapkan sebagai "continueUrl" di link verifikasi email. Halaman landing verifikasi email default akan menggunakannya untuk menampilkan link untuk kembali ke aplikasi jika sudah diinstal. Jika actionCodeSettings tidak ditentukan, tidak ada URL yang ditambahkan ke URL tindakan. URL status yang diberikan harus 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 akan diterapkan hanya 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 ditampilkan.
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 |
|---|---|---|
| providerId | 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 melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUser(uid: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| uid | string | uid sesuai dengan pengguna yang datanya akan diambil. |
Hasil:
Janji<UserRecord>
Promise terpenuhi 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 melihat 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:
Janji<UserRecord>
Promise terpenuhi 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 melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| Nomor telepon | string | Nomor telepon yang sesuai dengan pengguna yang datanya akan diambil. |
Hasil:
Janji<UserRecord>
Promise terpenuhi 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 melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| providerId | string | ID penyedia, misalnya, "google.com" untuk penyedia Google. |
| uid | string | ID pengguna untuk penyedia tertentu. |
Hasil:
Janji<UserRecord>
Promise terpenuhi dengan data pengguna yang sesuai dengan ID penyedia yang diberikan.
BaseAuth.getUsers()
Mendapatkan data pengguna yang sesuai dengan ID yang ditentukan.
Tidak ada jaminan pemesanan; khususnya, entri ke-n dalam daftar hasil tidak dijamin sesuai dengan entri ke-n dalam daftar parameter input.
Hanya maksimum 100 ID yang dapat diberikan. Jika lebih dari 100 ID diberikan, metode ini akan menampilkan FirebaseAuthError.
Tanda Tangan:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| pengenal | UserIdentifier[] | ID yang digunakan untuk menunjukkan data pengguna mana yang harus ditampilkan. Tidak boleh memiliki lebih dari 100 entri. |
Hasil:
Promise<GetUsersResult>
Promise yang di-resolve ke catatan 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 yang 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, serta keunikan ID lainnya yang dapat mengakibatkan duplikasi.
Tanda Tangan:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| pengguna | UserImportRecord[] | Daftar data pengguna yang akan diimpor ke Firebase Auth. |
| opsi | UserImportOptions | Opsi impor pengguna, yang diperlukan jika pengguna yang diberikan menyertakan kredensial sandi. |
Hasil:
Promise<UserImportResult>
Promise yang selesai saat operasi selesai dengan hasil impor. Data ini mencakup jumlah impor yang berhasil, jumlah impor yang gagal, dan error terkaitnya.
BaseAuth.listProviderConfigs()
Menampilkan daftar konfigurasi penyedia yang ada yang 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.
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 (khusus batch tunggal) dengan ukuran maxResults dimulai dari offset seperti yang ditentukan oleh pageToken. Ini digunakan untuk mengambil semua pengguna project tertentu dalam batch.
Lihat Menampilkan 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, 1000 jika tidak ditentukan. Jumlah ini juga merupakan batas maksimum yang diizinkan. |
| pageToken | string | Token halaman berikutnya. Jika tidak ditentukan, menampilkan pengguna yang memulai tanpa offset apa pun. |
Hasil:
Promise<ListUsersResult>
Promise yang diselesaikan 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 yang menjadi tempatnya dipanggil telah menyetel jamnya 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 dicetak, token ID yang ada dapat tetap aktif hingga masa berlakunya habis (satu jam). Untuk memverifikasi bahwa token ID dicabut, gunakan BaseAuth.verifyIdToken() jika checkRevoked disetel ke benar (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:
Janji<void>
Promise kosong dipenuhi setelah token refresh pengguna dicabut.
BaseAuth.setCustomUser Claimss()
Menetapkan klaim developer tambahan pada pengguna lama yang diidentifikasi oleh uid yang disediakan, yang biasanya digunakan untuk menentukan peran pengguna dan tingkat akses. Klaim ini akan diterapkan ke semua perangkat tempat pengguna login (setelah masa berlaku token habis atau saat token refresh dipaksa), dan saat pengguna login lagi. Jika nama klaim OIDC yang dicadangkan digunakan (sub, iat, iss, dll.), error akan ditampilkan. Parameter ini ditetapkan pada JWT token ID pengguna yang telah diautentikasi.
Lihat Menentukan peran dan tingkat akses pengguna untuk melihat 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. |
| klaimpenggunakustom | objek | null (kosong) | Developer mengklaim untuk menetapkan. 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 dikirimkan pada setiap permintaan yang diautentikasi. Untuk atribut pengguna yang tidak terkait dengan profil, gunakan database atau sistem penyimpanan terpisah lainnya. |
Hasil:
Janji<void>
Promise yang selesai saat operasi berhasil diselesaikan.
BaseAuth.updateProviderConfig()
Menampilkan promise yang di-resolve dengan AuthProviderConfig yang diupdate yang sesuai dengan ID penyedia yang ditentukan. Jika ID yang ditentukan tidak ada, error auth/configuration-not-found akan ditampilkan.
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 |
|---|---|---|
| providerId | string | ID penyedia yang sesuai dengan konfigurasi penyedia yang akan diperbarui. |
| diupdateConfig | UpdateAuthProviderRequest | Konfigurasi yang diperbarui. |
Hasil:
Promise<AuthProviderConfig>
Promise yang di-resolve dengan konfigurasi penyedia yang diupdate.
BaseAuth.updateUser()
Memperbarui pengguna yang ada.
Lihat bagian Memperbarui pengguna untuk melihat 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 yang akan diupdate. |
| properti | UpdateRequest | Properti yang akan diperbarui pada pengguna tertentu. |
Hasil:
Janji<UserRecord>
Promise terpenuhi dengan data pengguna yang diperbarui.
BaseAuth.verifyIdToken()
Memverifikasi token ID Firebase (JWT). Jika token valid, promise akan terpenuhi dengan klaim token yang didekode; jika tidak, janji itu ditolak.
Jika checkRevoked disetel ke benar (true), verifikasi terlebih dahulu apakah pengguna yang sesuai dinonaktifkan. Jika ya, error auth/user-disabled akan ditampilkan. Jika tidak, verifikasi apakah sesi yang sesuai dengan token ID telah dicabut. Jika sesi pengguna yang sesuai tidak valid, error auth/id-token-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak diterapkan.
Lihat Memverifikasi Token ID untuk melihat contoh kode dan dokumentasi mendetail.
Tanda Tangan:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| idToken | string | Token ID yang akan diverifikasi. |
| centangDicabut | boolean | Apakah akan memeriksa apakah token ID dicabut. Fungsi ini memerlukan permintaan tambahan ke backend Firebase Auth untuk memeriksa waktu tokensValidAfterTime untuk pengguna yang sesuai. Jika tidak ditentukan, pemeriksaan tambahan ini tidak diterapkan. |
Hasil:
Promise<DecodedIdToken>
Promise terpenuhi dengan klaim token yang didekode jika token ID valid; jika tidak, janji 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 tidak valid, error auth/session-cookie-revoked akan ditampilkan. Jika tidak ditentukan, pemeriksaan tidak dilakukan.
Lihat Memverifikasi Cookie Sesi untuk melihat contoh kode dan dokumentasi mendetail
Tanda Tangan:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| sessionCookie | string | Cookie sesi yang akan diverifikasi. |
| centangDicabut | boolean |
Hasil:
Promise<DecodedIdToken>
Promise dipenuhi dengan klaim yang didekode cookie sesi jika cookie sesi valid; jika tidak, janji yang ditolak.