Firebase is back at Google I/O on May 14! Register now.

Halaman ini diterjemahkan oleh Cloud Translation API.

firebase-admin.auth package

Firebase Authentication.

Functions

Fungsi	Deskripsi
getAuth(app)	Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu.`getAuth()` dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai `getAuth(app)` untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu.

Kelas

Class	Deskripsi
Autentikasi	Layanan Auth terikat dengan aplikasi yang disediakan. Instance Auth dapat memiliki beberapa tenant.
BaseAuth	Antarmuka induk yang umum untuk `Auth` API dan `TenantAwareAuth` API.
Info MultiFaktor	Antarmuka yang mewakili properti umum faktor kedua yang didaftarkan pengguna.
Setelan MultiFaktor	Setelan pengguna terkait multi-faktor.
PhoneMultiFactorInfo	Antarmuka yang mewakili faktor kedua yang didaftarkan pengguna khusus ponsel.
ProjectConfig	Mewakili konfigurasi project.
ProjectConfigManager	Mengelola (mendapatkan dan memperbarui) konfigurasi project saat ini.
Penyewa	Mewakili konfigurasi tenant.Dukungan multi-tenancy memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk penetapan harga dan fitur, lihat dokumentasi GCIP.Sebelum multi-tenancy dapat digunakan di project Google Cloud Identity Platform, tenant harus diizinkan di project tersebut melalui UI Konsol Cloud.Konfigurasi tenant memberikan informasi seperti nama tampilan, ID tenant, dan konfigurasi autentikasi email. Untuk pengelolaan konfigurasi penyedia OIDC/SAML, instance `TenantAwareAuth` harus digunakan, bukan `Tenant`, untuk mengambil daftar IdP yang dikonfigurasi di tenant. Saat mengonfigurasi penyedia ini, perhatikan bahwa tenant akan mewarisi domain yang diizinkan dan URI pengalihan yang diautentikasi dari project induknya.Semua setelan tenant lainnya juga akan diwarisi. Keduanya harus dikelola dari UI Cloud Console.
TenantAwareAuth	Antarmuka `Auth` berbasis tenant yang digunakan untuk mengelola pengguna, mengonfigurasi penyedia SAML/OIDC, membuat link email untuk reset sandi, verifikasi email, dll. untuk tenant tertentu.Dukungan multi-tenancy memerlukan Identity Platform (GCIP) Google Cloud. Untuk mempelajari GCIP lebih lanjut, termasuk harga dan fitur, lihat dokumentasi GCIP.Setiap tenant berisi penyedia identitas, setelan, dan kumpulan penggunanya sendiri. Dengan menggunakan `TenantAwareAuth`, pengguna untuk tenant tertentu dan konfigurasi OIDC/SAML yang sesuai juga dapat dikelola, token ID untuk pengguna yang login ke tenant tertentu dapat diverifikasi, dan link tindakan email juga dapat dibuat untuk pengguna yang termasuk dalam tenant.Instance `TenantAwareAuth` untuk `tenantId` tertentu dapat dibuat instance-nya dengan memanggil TenantManager.authForTenant().
TenantManager	Menentukan tenant manager yang digunakan untuk membantu mengelola operasi terkait tenant. Hal ini mencakup: Kemampuan untuk membuat, memperbarui, mencantumkan, mendapatkan, dan menghapus tenant untuk project pokok. Mendapatkan instance `TenantAwareAuth` untuk menjalankan operasi terkait Auth (pengelolaan pengguna, pengelolaan konfigurasi penyedia, verifikasi token, pembuatan link email, dll.) dalam konteks tenant tertentu.
Info Pengguna	Mewakili info pengguna dari penyedia identitas pihak ketiga seperti Google atau Facebook.
UserMetadata	Mewakili metadata pengguna.
UserRecord	Mewakili pengguna.

Antarmuka

Antarmuka	Deskripsi
ActionCodeSettings	Ini adalah antarmuka yang menentukan URL lanjutkan/status yang diperlukan dengan ID paket Android dan iOS opsional.
AllowByDefault	Menentukan kebijakan yang mengizinkan setiap wilayah secara default dan menambahkan wilayah yang tidak diizinkan ke daftar yang tidak diizinkan.
AllowByDefaultWrap	Konfigurasi Region SMS eksklusif bersama dari antarmuka AllowByDefault
Izinkan	Menentukan kebijakan yang hanya mengizinkan wilayah dengan menambahkannya secara eksplisit ke daftar yang diizinkan.
AllowlistOnlyWrap	Konfigurasi Region SMS yang saling eksklusif dari antarmuka yang Diizinkan
AuthProviderConfigFilter	Antarmuka filter yang digunakan untuk mencantumkan konfigurasi penyedia. Hal ini digunakan saat menentukan cara mencantumkan penyedia identitas yang dikonfigurasi melalui BaseAuth.listProviderConfigs().
BaseAuthProviderConfig	Antarmuka konfigurasi penyedia Auth dasar.
BaseCreateMultiFactorInfoRequest	Antarmuka yang mewakili properti dasar faktor kedua yang didaftarkan pengguna untuk `CreateRequest`.
BaseUpdateMultiFactorInfoRequest	Antarmuka yang mewakili properti umum faktor kedua yang didaftarkan pengguna untuk `UpdateRequest`.
CreatePhoneMultiFactorInfoRequest	Antarmuka yang mewakili faktor kedua yang didaftarkan pengguna khusus ponsel untuk `CreateRequest`.
CreateRequest	Antarmuka yang mewakili properti yang akan ditetapkan pada data pengguna baru yang akan dibuat.
CustomStrengthOptionsConfig	Batasan yang akan diterapkan pada kebijakan sandi
DecodedAuthBlockingToken
DecodedIdToken	Antarmuka yang mewakili token ID Firebase yang didekode, yang ditampilkan dari metode BaseAuth.verifyIdToken().Token ID Firebase adalah Token Web JSON (JWT) yang sesuai dengan spesifikasi OpenID Connect. Lihat [bagian Token ID pada spesifikasi OpenID Connect](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) untuk informasi selengkapnya tentang properti spesifik di bawah ini.
DeleteUsersResult	Mewakili hasil BaseAuth.deleteUsers(). API.
EmailIdentifier	Digunakan untuk mencari akun melalui email.Lihat BaseAuth.getUsers().
EmailPrivacyConfig	Konfigurasi privasi email project atau tenant.
EmailSignInProviderConfig	Konfigurasi penyedia login email.
GetUsersResult	Mewakili hasil API BaseAuth.getUsers().
ListProviderConfigResults	Antarmuka respons untuk mencantumkan konfigurasi penyedia. Opsi ini hanya tersedia saat mencantumkan semua konfigurasi penyedia identitas melalui BaseAuth.listProviderConfigs().
ListTenantsResult	Antarmuka yang mewakili objek yang ditampilkan dari operasi TenantManager.listTenants(). Berisi daftar tenant untuk batch saat ini dan token halaman berikutnya jika tersedia.
ListUsersResult	Antarmuka yang mewakili objek yang ditampilkan dari operasi BaseAuth.listUsers(). Berisi daftar pengguna untuk batch saat ini dan token halaman berikutnya jika tersedia.
MultiFactorConfig	Antarmuka yang mewakili konfigurasi multi-faktor. Atribut ini dapat digunakan untuk menentukan apakah autentikasi multi-faktor diaktifkan atau dinonaktifkan dan daftar verifikasi faktor kedua yang didukung.
MultiFactorCreateSettings	Setelan pengguna yang terkait dengan multi-faktor untuk operasi pembuatan.
MultiFactorProviderConfig	Antarmuka yang mewakili konfigurasi penyedia autentikasi multi-faktor. Antarmuka ini digunakan untuk penyedia autentikasi faktor kedua selain SMS. Saat ini, hanya TOTP yang didukung.
MultiFactorUpdateSettings	Setelan pengguna yang terkait multi-faktor untuk operasi update.
OAuthResponseType	Antarmuka yang merepresentasikan objek respons penyedia OIDC untuk alur otorisasi OAuth. Salah satu setelan berikut diperlukan: Tetapkan `code` ke `true` untuk alur kode. Tetapkan `idToken` ke `true` untuk alur token ID.
OIDCAuthProviderConfig	Antarmuka konfigurasi penyedia Auth [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html). Penyedia OIDC dapat dibuat melalui BaseAuth.createProviderConfig().
OIDCUpdateAuthProviderRequest	Antarmuka permintaan untuk mengupdate penyedia Auth OIDC. Ini digunakan saat memperbarui konfigurasi penyedia OIDC melalui BaseAuth.updateProviderConfig().
PasswordPolicyConfig	Konfigurasi kebijakan sandi untuk project atau tenant
PhoneIdentifier	Digunakan untuk mencari akun berdasarkan nomor telepon.Lihat BaseAuth.getUsers().
ProviderIdentifier	Digunakan untuk mencari akun oleh penyedia gabungan.Lihat BaseAuth.getUsers().
RecaptchaConfig	Antarmuka permintaan untuk mengupdate Konfigurasi reCAPTCHA. Dengan mengaktifkan Integrasi reCAPTCHA Enterprise, Anda menyetujui Persyaratan Layanan reCAPTCHA Enterprise.
RecaptchaKey	Konfigurasi kunci reCAPTCHA.
RecaptchaManagedRule	Konfigurasi untuk aturan tindakan reCAPTCHA.
SAMLAuthProviderConfig	Antarmuka konfigurasi penyedia Auth [SAML](http://docs.oasis-open.org/security/SAML/Post2.0/sstc- SAML-tech-overview-2.0.html). Penyedia SAML dapat dibuat melalui BaseAuth.createProviderConfig().
SAMLUpdateAuthProviderRequest	Antarmuka permintaan untuk mengupdate penyedia Auth SAML. Digunakan saat memperbarui konfigurasi penyedia SAML melalui BaseAuth.updateProviderConfig().
SessionCookieOptions	Antarmuka yang mewakili opsi cookie sesi yang diperlukan untuk metode BaseAuth.createSessionCookie().
TotpMultiFactorProviderConfig	Antarmuka yang mewakili setelan konfigurasi untuk autentikasi faktor kedua TOTP.
UidIdentifier	Digunakan untuk mencari akun oleh uid.Lihat BaseAuth.getUsers().
UpdatePhoneMultiFactorInfoRequest	Antarmuka yang mewakili faktor kedua yang didaftarkan pengguna khusus ponsel untuk `UpdateRequest`.
UpdateProjectConfigRequest	Antarmuka yang mewakili properti yang akan diperbarui pada konfigurasi project yang disediakan.
UpdateRequest	Antarmuka yang menampilkan properti yang akan diperbarui pada pengguna yang disediakan.
UpdateTenantRequest	Antarmuka yang mewakili properti yang akan diperbarui di tenant yang disediakan.
UserImportOptions	Antarmuka yang mewakili opsi impor pengguna yang diperlukan untuk metode BaseAuth.importUsers(). Ini digunakan untuk memberikan informasi algoritma {i>hashing <i}dari{i> password<i}.
UserImportRecord	Antarmuka yang mewakili pengguna untuk diimpor ke Firebase Auth melalui metode BaseAuth.importUsers().
UserImportResult	Antarmuka yang mewakili respons dari metode BaseAuth.importUsers() untuk mengimpor batch pengguna ke Firebase Auth.
UserMetadataRequest	Metadata pengguna yang akan disertakan saat mengimpor pengguna.
UserProvider	Mewakili penyedia identitas pengguna yang dapat dikaitkan dengan pengguna Firebase.
UserProviderRequest	Data penyedia pengguna yang akan disertakan saat mengimpor pengguna.

Jenis Alias

Jenis Alias	Deskripsi
AuthFactorType	Mengidentifikasi jenis faktor kedua.
AuthProviderConfig	Jenis konfigurasi penyedia Auth. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	Jenis yang mewakili properti faktor kedua yang didaftarkan pengguna untuk `CreateRequest`.
CreateTenantRequest	Antarmuka yang mewakili properti untuk ditetapkan pada tenant baru.
HashAlgorithmType
MultiFactorConfigState	Mengidentifikasi status konfigurasi multi-faktor.
PasswordPolicyEnforcementState	Status penerapan kebijakan sandi.
RecaptchaAction	Tindakan yang harus diambil untuk permintaan yang dilindungi reCAPTCHA. - 'BLOKIR': Permintaan yang dilindungi reCAPTCHA akan diblokir.
RecaptchaKeyClientType	Jenis platform kunci.
RecaptchaProviderEnforcementState	Status penerapan perlindungan reCAPTCHA. - 'NONAKTIF': Tidak diterapkan. - 'AUDIT': Membuat penilaian tetapi tidak menerapkan hasilnya. - 'BERTINDAK': Buat penilaian dan terapkan hasilnya.
SmsRegionConfig	Antarmuka permintaan untuk memperbarui Konfigurasi Region SMS. Mengonfigurasi wilayah tempat pengguna diizinkan untuk mengirimkan SMS verifikasi. Hal ini didasarkan pada kode panggilan dari nomor telepon tujuan.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	Jenis yang mewakili properti faktor kedua yang didaftarkan pengguna untuk `UpdateRequest`.
IDPengguna	Mengidentifikasi pengguna untuk dicari.

getAuth(aplikasi)

Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu.

getAuth() dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai getAuth(app) untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu.

Tanda Tangan:

export declare function getAuth(app?: App): Auth;

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi

Hasil:

Autentikasi

Contoh 1

// Get the Auth service for the default app
const defaultAuth = getAuth();

Contoh 2

// Get the Auth service for a given app
const otherAuth = getAuth(otherApp);

AuthFactorType

Mengidentifikasi jenis faktor kedua.

Tanda Tangan:

export type AuthFactorType = 'phone';

AuthProviderConfig

Jenis konfigurasi penyedia Auth. BaseAuth.createProviderConfig().

Tanda Tangan:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

Jenis yang mewakili properti faktor kedua yang didaftarkan pengguna untuk CreateRequest.

Tanda Tangan:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Antarmuka yang mewakili properti untuk ditetapkan pada tenant baru.

Tanda Tangan:

export type CreateTenantRequest = UpdateTenantRequest;

JenisAlgoritma Hash

Tanda Tangan:

export type HashAlgorithmType = 'SCRYPT' | 'STANDARD_SCRYPT' | 'HMAC_SHA512' | 'HMAC_SHA256' | 'HMAC_SHA1' | 'HMAC_MD5' | 'MD5' | 'PBKDF_SHA1' | 'BCRYPT' | 'PBKDF2_SHA256' | 'SHA512' | 'SHA256' | 'SHA1';

{i>MultiFactorConfigState<i}

Mengidentifikasi status konfigurasi multi-faktor.

Tanda Tangan:

export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';

StatusPasswordPolicyEnforcement

Status penerapan kebijakan sandi.

Tanda Tangan:

export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';

RecaptchaAction

Tindakan yang harus diambil untuk permintaan yang dilindungi reCAPTCHA. - 'BLOKIR': Permintaan yang dilindungi reCAPTCHA akan diblokir.

Tanda Tangan:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Jenis platform kunci.

Tanda Tangan:

export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';

RecaptchaProviderEnforcementState

Status penerapan perlindungan reCAPTCHA. - 'NONAKTIF': Tidak diterapkan. - 'AUDIT': Membuat penilaian tetapi tidak menerapkan hasilnya. - 'BERTINDAK': Buat penilaian dan terapkan hasilnya.

Tanda Tangan:

export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';

{i>SmsRegionConfig<i}

Antarmuka permintaan untuk memperbarui Konfigurasi Region SMS. Mengonfigurasi wilayah tempat pengguna diizinkan untuk mengirimkan SMS verifikasi. Hal ini didasarkan pada kode panggilan dari nomor telepon tujuan.

Tanda Tangan:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

Tanda Tangan:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

UpdateMultiFactorInfoRequest

Jenis yang mewakili properti faktor kedua yang didaftarkan pengguna untuk UpdateRequest.

Tanda Tangan:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

ID Pengguna

Mengidentifikasi pengguna untuk dicari.

Tanda Tangan:

export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;