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

Bu sayfa, Cloud Translation API ile çevrilmiştir.

firebase-admin.auth package

Firebase Authentication.

İşlevler

İşlev	Açıklama
getAuth(uygulama)	Varsayılan uygulama veya belirli bir uygulama için Auth hizmetini alır.`getAuth()`, varsayılan uygulamanın Auth hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkili Auth hizmetine erişmek için `getAuth(app)` olarak çağrılabilir.

Sınıflar

Sınıf	Açıklama
Auth	Sağlanan uygulamaya bağlı Auth hizmeti. Auth örneğinin birden fazla kiracısı olabilir.
BaseAuth	Hem `Auth` hem de `TenantAwareAuth` API'leri için ortak üst arayüz.
ÇokFaktörlüBilgi	Kullanıcı tarafından kaydedilen bir ikinci faktörün ortak özelliklerini temsil eden arayüz.
Çoklu Faktörlü Ayarlar	Çok öğeli kimlik doğrulamasıyla ilgili kullanıcı ayarları.
TelefonÇokFaktörüBilgileri	Telefona özel, kullanıcıya kaydedilen iki faktörlü kimlik doğrulamayı temsil eden arayüz.
ProjectConfig	Proje yapılandırmasını temsil eder.
ProjectConfigManager	Geçerli proje yapılandırmasını yönetir (alır ve günceller).
Kiracı	Kiracı yapılandırmasını temsil eder.Çok kiracılı destek için Google Cloud Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.Bir Google Cloud Identity Platform projesinde çok kiracılı kümenin kullanılabilmesi için önce Cloud Console kullanıcı arayüzü aracılığıyla ilgili projede kiracılara izin verilmesi gerekir.Kiracı yapılandırması; görünen ad, kiracı tanımlayıcısı ve e-posta kimlik doğrulaması yapılandırması gibi bilgiler sağlar. OIDC/SAML sağlayıcı yapılandırma yönetiminde, bir kiracıdaki yapılandırılmış IdP'lerin listesini almak için `Tenant` yerine `TenantAwareAuth` örnekleri kullanılmalıdır. Bu sağlayıcıları yapılandırırken, kiracıların üst projelerinin beyaz listedeki alanları ve kimliği doğrulanmış yönlendirme URI'lerini devralacağını unutmayın.Bir kiracının diğer tüm ayarları da devralınır. Bunların Cloud Console kullanıcı arayüzünden yönetilmesi gerekir.
TenantAwareAuth	Kullanıcıları yönetmek, SAML/OIDC sağlayıcılarını yapılandırmak, belirli kiracılar için şifre sıfırlama için e-posta bağlantıları oluşturmak, e-posta doğrulaması vb. için kullanılan kiracıya duyarlı `Auth` arayüzü.Çok kiracılı destek için Google Cloud Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.Her kiracı kendi kimlik sağlayıcıları, ayarları ve kullanıcı gruplarını içerir. `TenantAwareAuth` ile belirli bir kiracının kullanıcıları ve ilgili OIDC/SAML yapılandırmaları da yönetilebilir. Belirli bir kiracıda oturum açmış kullanıcıların kimlik jetonları doğrulanabilir ve kiracıya ait kullanıcılar için e-posta işlem bağlantıları da oluşturulabilir. Belirli bir `tenantId` için `TenantAwareAuth` örnekleri, TenantManager.authForTenant() çağrısı yapılarak örneklenebilir.
Kiracı Yönetici	Kiracıyla ilgili işlemleri yönetmeye yardımcı olmak için kullanılan kiracı yöneticisini tanımlar. Bunlardan bazıları: Temel proje için kiracı oluşturma, güncelleme, listeleme, alma ve silme özelliği. Belirtilen bir kiracı bağlamında, Auth ile ilgili işlemleri (kullanıcı yönetimi, sağlayıcı yapılandırma yönetimi, jeton doğrulaması, e-posta bağlantısı oluşturma vb.) çalıştırmak için bir `TenantAwareAuth` örneği alma.
Kullanıcı Bilgileri	Kullanıcının Google veya Facebook gibi üçüncü taraf bir kimlik sağlayıcıdan aldığı bilgileri temsil eder.
KullanıcıMeta Verileri	Kullanıcının meta verilerini temsil eder.
Kullanıcı Kaydı	Kullanıcıyı temsil eder.

Arayüzler

Arayüz	Açıklama
ActionCodeSettings	Bu arayüz, isteğe bağlı Android ve iOS paket tanımlayıcılarıyla birlikte zorunlu devam/durum URL'sini tanımlayan arayüzdür.
AllowByDefault	Varsayılan olarak her bölgeye izin verme ve izin verilmeyen bölgeleri izin verme listesine ekleme politikası tanımlar.
AllowByDefaultWrap	AllowByDefault arayüzünün karşılıklı özel SMS Bölgesi Yapılandırması
Yalnızca İzin Verilenler Listesi	Bölgeleri izin verilenler listesine açıkça ekleyerek yalnızca izin verilen bir politika tanımlar.
AllowlistOnlyWrap	AllowlistOnly arayüzünün karşılıklı SMS Bölge Yapılandırması
AuthProviderConfigFilter	Sağlayıcı yapılandırmalarını listelemek için kullanılan filtre arayüzü. Bu, yapılandırılmış kimlik sağlayıcılarının BaseAuth.listProviderConfigs() aracılığıyla nasıl listeleneceğini belirtirken kullanılır.
BaseAuthProviderConfig	Temel Auth sağlayıcısı yapılandırma arayüzü.
BaseCreateMultiFactorInfoRequest	`CreateRequest` için kullanıcı tarafından kaydedilen iki faktörün temel özelliklerini temsil eden arayüz.
TemelGüncellemeÇoklu FaktörBilgi İsteği	`UpdateRequest` için kullanıcı tarafından kaydedilen ikinci faktörünün genel özelliklerini temsil eden arayüz.
CreatePhoneMultiFactorInfoRequest	`CreateRequest` için telefona özel, kullanıcıya kaydedilen iki faktörlü kimlik doğrulamayı temsil eden arayüz.
CreateRequest (İstek Oluştur)	Oluşturulacak yeni bir kullanıcı kaydında ayarlanacak özellikleri temsil eden arayüz.
CustomStrengthOptionsConfig	Şifre politikasında zorunlu kılınacak kısıtlamalar
DecodedAuthBlockToken
DecodedIdToken	BaseAuth.verifyIdToken() yönteminden döndürülen, kodu çözülmüş bir Firebase kimlik jetonunu temsil eden arayüz.Firebase kimlik jetonları, OpenID Connect spesifikasyonuyla uyumlu JSON Web Token'larıdır (JWT'ler). Aşağıdaki belirli özellikler hakkında daha fazla bilgi için [OpenID Connect spesifikasyonunun Kimlik Jetonu bölümüne](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) bakın.
DeleteUsersResult	BaseAuth.deleteUsers() API'sinin sonucunu temsil eder.
EmailIdentifier (E-posta Tanımlayıcısı)	E-posta yoluyla bir hesabı aramak için kullanılır.BaseAuth.getUsers()
EmailPrivacyConfig	Bir proje veya kiracının e-posta gizliliği yapılandırması.
EmailSignInProviderConfig	E-posta oturum açma sağlayıcı yapılandırması.
GetUsersResult (KullanıcıSonuçları Al)	BaseAuth.getUsers() API'sının sonucunu temsil eder.
ListProviderConfigResults	Sağlayıcı yapılandırmalarını listelemeye yönelik yanıt arayüzü. Bu yalnızca BaseAuth.listProviderConfigs() aracılığıyla tüm kimlik sağlayıcılarının yapılandırmaları listelenirken kullanılabilir.
ListeKiracıSonucu	TenantManager.listTenants() işleminden döndürülen nesneyi temsil eden arayüz. Geçerli grubun kiracı listesini ve varsa sonraki sayfa jetonunu içerir.
ListeKullanıcılarSonuç	BaseAuth.listUsers() işleminden döndürülen nesneyi temsil eden arayüz. Geçerli toplu parti için kullanıcı listesini ve varsa sonraki sayfa jetonunu içerir.
MultiFactorConfig	Çok öğeli yapılandırmayı temsil eden arayüz. Bu, çok öğeli kimlik doğrulamasının etkin mi yoksa devre dışı mı olduğunu ve desteklenen iki etmenli kimlik doğrulama sorgulamalarının listesini tanımlamak için kullanılabilir.
MultiFactorCreateSettings	Oluşturma işlemleri için çok öğeli ilgili kullanıcı ayarları.
MultiFactorProviderConfig	Çok öğeli kimlik doğrulaması sağlayıcı yapılandırmasını temsil eden arayüz. Bu arayüz, SMS dışındaki iki etmenli kimlik doğrulama sağlayıcıları için kullanılır. Şu anda yalnızca TOTP desteklenmektedir.
Çoklu Faktör Güncelleme Ayarları	Güncelleme işlemleri için çok öğeli ilgili kullanıcı ayarları.
OAuthResponseType	OAuth yetkilendirme akışı için OIDC sağlayıcısının yanıt nesnesini temsil eden arayüz. Aşağıdaki ayarlardan biri gerekli: Kod akışı için `code` değerini `true` olarak ayarlayın. Kimlik jetonu akışı için `idToken` değerini `true` olarak ayarlayın.
OIDCAuthProviderConfig	[OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth sağlayıcısı yapılandırma arayüzü. BaseAuth.createProviderConfig() aracılığıyla bir OIDC sağlayıcısı oluşturulabilir.
OIDCUpdateAuthProviderRequest	OIDC Auth sağlayıcısını güncellemek için istek arayüzü. Bu, OIDC sağlayıcısının yapılandırması BaseAuth.updateProviderConfig() aracılığıyla güncellenirken kullanılır.
PasswordPolicyConfig	Bir proje veya kiracı için şifre politikası yapılandırması
PhoneIdentifier (Telefon Tanımlayıcısı)	Telefon numarasına göre bir hesabı aramak için kullanılır.BaseAuth.getUsers()
ProviderIdentifier	Birleşik sağlayıcı tarafından hesap aramak için kullanılır.BaseAuth.getUsers() öğesini inceleyin.
RecaptchaConfig	reCAPTCHA Yapılandırmasını güncellemek için istek arayüzü reCAPTCHA Enterprise Entegrasyonu'nu etkinleştirerek reCAPTCHA Enterprise Hizmet Şartları'nı kabul etmiş olursunuz.
RecaptchaKey	reCAPTCHA anahtarı yapılandırması.
RecaptchaManagedRule	reCAPTCHA işlem kuralı yapılandırması.
SAMLAuthProviderConfig	[SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) Kimlik Doğrulama sağlayıcısı yapılandırma arayüzü. SAML sağlayıcısı, BaseAuth.createProviderConfig() aracılığıyla oluşturulabilir.
SAMLUpdateAuthProviderRequest	Bir SAML Kimlik Doğrulama sağlayıcısını güncellemek için kullanılan istek arayüzü. Bu API, SAML sağlayıcısının yapılandırması BaseAuth.updateProviderConfig() aracılığıyla güncellenirken kullanılır.
SessionCookieOptions	BaseAuth.createSessionCookie() yöntemi için gereken oturum çerezi seçeneklerini temsil eden arayüz.
TotpMultiFactorProviderConfig	TOTP iki etmenli kimlik doğrulaması için yapılandırma ayarlarını gösteren arayüz.
UidIdentifier	UID tarafından hesap aramak için kullanılır.BaseAuth.getUsers() konusuna bakın.
Telefonu GüncellemeÇokFaktörüBilgi İsteği	`UpdateRequest` için telefona özel, kullanıcıya kaydedilen iki faktörlü kimlik doğrulamayı temsil eden arayüz.
UpdateProjectConfigRequest	Sağlanan proje yapılandırmasında güncellenecek özellikleri temsil eden arayüz.
Güncelleme İsteği	Sağlanan kullanıcıda güncellenecek özellikleri temsil eden arayüz.
Kiracıİsteği Güncelleme	Sağlanan kiracıda güncellenecek mülkleri temsil eden arayüz.
UserImportOptions	BaseAuth.importUsers() yöntemi için gereken kullanıcı içe aktarma seçeneklerini gösteren arayüz. Bu, şifre karma oluşturma algoritması bilgilerini sağlamak için kullanılır.
UserImportRecord	BaseAuth.importUsers() yöntemiyle Firebase Auth'a içe aktarmak üzere kullanıcıyı temsil eden arayüz.
UserImportResult	Kullanıcıların Firebase Auth'a toplu olarak içe aktarılması için BaseAuth.importUsers() yönteminden gelen yanıtı temsil eden arayüz.
UserMetadataRequest	Bir kullanıcıyı içe aktarırken eklenecek kullanıcı meta verileri.
UserProvider	Bir Firebase kullanıcısıyla ilişkilendirilebilen kullanıcı kimliği sağlayıcısını temsil eder.
UserProviderRequest	Bir kullanıcıyı içe aktarırken dahil edilecek kullanıcı sağlayıcı verileri.

Takma Adları Yazın

Takma Ad Yazın	Açıklama
AuthFactorType (Kimlik Doğrulama Faktörü Türü)	İkinci faktör türünü tanımlar.
AuthProviderConfig	Auth sağlayıcı yapılandırma türü. BaseAuth.createProviderConfig().
CreateMultiFactorInfoRequest	`CreateRequest` için kullanıcı tarafından kaydedilen bir ikinci faktörün özelliklerini temsil eden tür.
CreateTenantRequest	Yeni bir kiracı üzerinde ayarlanacak özellikleri temsil eden arayüz.
Karma AlgorithmTürü
MultiFactorConfigState	Çok öğeli yapılandırma durumunu tanımlar.
PasswordPolicyEnforcementState	Bir şifre politikasının zorunlu kılma durumu.
RecaptchaAction	reCAPTCHA korumalı istekler için yapılacak işlemler. - "ENGELLE": reCAPTCHA korumalı istek engellenir.
RecaptchaKeyClientType	Anahtarın platform türü.
RecaptchaProviderEnforcementState	reCAPTCHA korumasının zorunluluk durumu. - "KAPALI": Uygulanmaz. - "DENETLE": Değerlendirme oluşturun ancak sonucu zorunlu kılmayın. - "ENFORCE": Değerlendirme oluşturun ve sonucu zorunlu kılın.
SmsRegionConfig	SMS Bölge Yapılandırması'nı güncellemek için istek arayüzü. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu değer, hedef telefon numarasının arama koduna dayanır.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	`UpdateRequest` için kullanıcı tarafından kaydedilen bir ikinci faktörün özelliklerini temsil eden tür.
UserIdentifier	Aranacak kullanıcıyı tanımlar.

getAuth(uygulama)

Varsayılan uygulama veya belirli bir uygulama için Auth hizmetini alır.

getAuth(), varsayılan uygulamanın Auth hizmetine erişmek için bağımsız değişken olmadan veya belirli bir uygulamayla ilişkili Auth hizmetine erişmek için getAuth(app) olarak çağrılabilir.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	Uygulamaya

İadeler:

Auth

1. örnek

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

2. örnek

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

Kimlik Doğrulama Faktörü Türü

İkinci faktör türünü tanımlar.

İmza:

export type AuthFactorType = 'phone';

AuthProviderConfig

Auth sağlayıcı yapılandırma türü. BaseAuth.createProviderConfig().

İmza:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

Birden Çok Öğe Bilgi İsteği Oluşturma

CreateRequest için kullanıcı kaydı ikinci faktörünün özelliklerini temsil eden tür.

İmza:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest

Yeni bir kiracı üzerinde ayarlanacak özellikleri temsil eden arayüz.

İmza:

export type CreateTenantRequest = UpdateTenantRequest;

Karma Algoritma Türü

İmza:

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

MultiFactorConfigState

Çok öğeli yapılandırma durumunu tanımlar.

İmza:

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

Parola Politikası Uygulama Durumu

Bir şifre politikasının zorunlu kılma durumu.

İmza:

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

Yeniden Captcha İşlem

reCAPTCHA korumalı istekler için yapılacak işlemler. - "ENGELLE": reCAPTCHA korumalı istek engellenir.

İmza:

export type RecaptchaAction = 'BLOCK';

RecaptchaKeyClientType

Anahtarın platform türü.

İmza:

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

RecaptchaProviderEnforcementState

reCAPTCHA korumasının zorunluluk durumu. - "KAPALI": Uygulanmaz. - "DENETLE": Değerlendirme oluşturun ancak sonucu zorunlu kılmayın. - "ENFORCE": Değerlendirme oluşturun ve sonucu zorunlu kılın.

İmza:

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

SmsRegionConfig

SMS Bölge Yapılandırması'nı güncellemek için istek arayüzü. Kullanıcıların doğrulama SMS'i göndermesine izin verilen bölgeleri yapılandırır. Bu değer, hedef telefon numarasının arama koduna dayanır.

İmza:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

İmza:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

MultiFactorInfoRequest Güncelleme

UpdateRequest için kullanıcı tarafından kaydedilen bir ikinci faktörünün özelliklerini temsil eden tür.

İmza:

export type UpdateMultiFactorInfoRequest = UpdatePhoneMultiFactorInfoRequest;

Kullanıcı Tanımlayıcısı

Aranacak kullanıcıyı tanımlar.

İmza:

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