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şkilendirilmiş Auth hizmetine erişmek için getAuth(app) olarak çağrılabilir.

Sınıflar

Sınıf	Açıklama
Yetkilendirme	Sağlanan uygulamaya bağlı kimlik doğrulama hizmeti. Auth örneğinde birden fazla kiracı olabilir.
AuthClientErrorCode	Kimlik doğrulama istemcisi hata kodları ve varsayılan mesajları.
BaseAuth	Auth ve TenantAwareAuth API'leri için ortak üst arayüz.
FirebaseAuthError	Firebase Auth hata kodu yapısı. Bu, PrefixedFirebaseError uzantısını genişletir.
MultiFactorInfo	Kullanıcı tarafından kaydedilmiş ikinci faktörün ortak özelliklerini temsil eden arayüz.
MultiFaktörAyarları	Çok öğeliyle ilgili kullanıcı ayarları.
TelefonMultiFactorInfo	Telefona özel, kullanıcı tarafından kaydedilmiş ikinci faktörü 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 belgelerine bakın.Google Cloud Identity Platform projesinde çok kiracılı bir yapı kullanılabilmesi için önce kiracıya bu projede Cloud Console kullanıcı arayüzü üzerinden izin verilmelidir.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, 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ını 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, şifre sıfırlama işlemi için e-posta bağlantıları oluşturmak ve belirli kiracılar için e-posta doğrulaması yapmak gibi işlemlerde kullanılan kiracı duyarlı Auth arayüzüdür.Çok kiracılı destek için Google Cloud'un Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın.Her kiracının kendi kimlik sağlayıcıları, ayarları ve kullanıcı grupları vardır. TenantAwareAuth kullanılarak, belirli bir kiracı ve ilgili OIDC/SAML yapılandırmaları için kullanıcılar yönetilebilir, belirli bir kiracıda oturum açan kullanıcıların kimlik jetonları da doğrulanabilir ve kiracıya ait kullanıcılar için e-posta işlemi bağlantıları oluşturulabilir.Belirli bir tenantId için TenantAwareAuth örnekleri, TenantManager.authForTenant() çağrısı yapılarak oluşturulabilir.
Kiracı Yöneticisi	Kiracıyla ilgili işlemleri yönetmeye yardımcı olması 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. Belirli bir kiracı bağlamında Auth ile ilgili işlemleri (kullanıcı yönetimi, sağlayıcı yapılandırma yönetimi, jeton doğrulama, e-posta bağlantısı oluşturma vb.) çalıştırmak için bir TenantAwareAuth örneği alma.
Kullanıcı Bilgileri	Google veya Facebook gibi üçüncü taraf bir kimlik sağlayıcıdaki kullanıcı bilgilerini temsil eder.
KullanıcıMeta Verileri	Bir kullanıcının meta verilerini temsil eder.
Kullanıcı Kaydı	Bir kullanıcıyı temsil eder.

Arayüzler

Arayüz	Açıklama
ActionCodeSettings	Bu, gerekli devam/durum URL'sini isteğe bağlı Android ve iOS paket tanımlayıcılarıyla tanımlayan arayüzdür.
AllowByDefault	Her bölgeye varsayılan olarak izin verme ve izin verilmeyen bölgeleri izin verilmeyenler listesine ekleme politikasını tanımlar.
AllowByDefaultWrap	AllowByDefault arayüzünün karşılıklı özel SMS Region Config öğesi
Yalnızca İzin Verilenler Listesi	Bölgeleri izin verilenler listesine açıkça ekleyerek yalnızca bölgelere izin verme politikasını tanımlar.
AllowlistOnlyWrap	AllowlistOnly arayüzünün karşılıklı özel SMS Region Config özelliği
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 BaseAuth.listProviderConfigs() aracılığıyla nasıl listeleneceğini belirlerken kullanılır.
BaseAuthProviderConfig	Temel Kimlik Doğrulama sağlayıcısı yapılandırma arayüzü.
BaseCreateMultiFactorInfoRequest	CreateRequest için kullanıcının kayıtlı ikinci faktörünün temel özelliklerini temsil eden arayüz.
BaseUpdateMultiFactorInfoRequest	UpdateRequest için kullanıcının kayıtlı ikinci faktörünün ortak özelliklerini temsil eden arayüz.
CreatePhoneMultiFactorInfoRequest	CreateRequest için telefona özel, kullanıcı tarafından kaydedilmiş ikinci faktörü 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 uygulanacak kısıtlamalar
DecodedAuthBlockToken
Kod Çözme Kimliği	BaseAuth.verifyIdToken() yönteminden döndürülen, kodu çözülmüş bir Firebase kimlik jetonunu temsil eden arayüz.Firebase kimlik jetonları, COPPA Connect spesifikasyonuyla uyumlu JSON Web Jetonlarıdır (JWT'lar). Aşağıdaki özellikler hakkında daha fazla bilgi edinmek için [Identity Connect spesifikasyonunun Kimlik Jetonu bölümüne](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) bakın.
DeleteUsersResult	BaseAuth.deleteUsers() işlevinin sonucunu temsil eder. API'ye gidin.
EmailIdentifier	E-postayla hesap aramak için kullanılır.BaseAuth.getUsers() sayfasına göz atın.
EmailPrivacyConfig	Bir projenin veya kiracının e-posta gizlilik yapılandırması.
EmailSignInProviderConfig	E-posta oturum açma sağlayıcısı yapılandırması.
GetUsersResult	BaseAuth.getUsers() API'sinin sonucunu gösterir.
ListProviderConfigResults	Sağlayıcı yapılandırmalarını listelemek için kullanılan yanıt arayüzü. Bu seçenek yalnızca, tüm kimlik sağlayıcıların BaseAuth.listProviderConfigs() aracılığıyla yapılandırmaları içerir.
ListTenantsResult	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.
ListUsersResult	BaseAuth.listUsers() işleminden döndürülen nesneyi temsil eden arayüz. Geçerli grup ve varsa sonraki sayfa jetonu için kullanıcıların listesini 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 ikinci etmen sorgulamalarının listesini tanımlamak için kullanılabilir.
MultiFactorCreateSettings	Oluşturma işlemleri için çok öğeliyle 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.
MultiFactorUpdateSettings	Güncelleme işlemleri için çok öğeliyle 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 gereklidir: Kod akışı için code değerini true olarak ayarlayın. Kimlik jeton akışı için idToken değerini true olarak ayarlayın.
OIDCAuthProviderConfig	[OIDC](https://openid.net/specs/openid-connect-core-1_0-Final.html) Kimlik Doğrulama sağlayıcısı yapılandırma arayüzü. BaseAuth.createProviderConfig() aracılığıyla bir OIDC sağlayıcısı oluşturulabilir.
OIDCUpdateAuthProviderRequest	OIDC kimlik doğrulama sağlayıcısını güncellemek için kullanılan istek arayüzü. Bu, BaseAuth.updateProviderConfig() aracılığıyla bir OIDC sağlayıcının yapılandırmasını güncellerken kullanılır.
PasswordPolicyConfig	Bir proje veya kiracı için şifre politikası yapılandırması
PhoneIdentifier	Telefon numarasıyla hesap aramak için kullanılır.Bkz. BaseAuth.getUsers().
ProviderIdentifier	Birleştirilmiş sağlayıcı tarafından hesap aramak için kullanılır.Bkz. BaseAuth.getUsers().
RecaptchaConfig	reCAPTCHA yapılandırmasını güncellemek için kullanılan istek arayüzü. reCAPTCHA Enterprise Entegrasyonu'nu etkinleştirerek reCAPTCHA Enterprise Hizmet Şartları'nı kabul etmiş olursunuz.
RecaptchaKey	reCAPTCHA anahtarı yapılandırması.
RecaptchaManagedKural	reCAPTCHA işlem kuralının yapılandırması.
SAMLAuthProviderConfig	[SAML](http://docs.oasis-open.org/security/SAML/Post2.0/sstc-SAML-tech-overview-2.0.html) Auth sağlayıcısı yapılandırma arayüzü. SAML sağlayıcısı, BaseAuth.createProviderConfig() aracılığıyla oluşturulabilir.
SAMLUpdateAuthProviderRequest	SAML Auth sağlayıcısını güncellemek için istek arayüzü. Bu, BaseAuth.updateProviderConfig() aracılığıyla bir SAML sağlayıcının yapılandırmasını güncellerken kullanılır.
SessionCookieOptions	BaseAuth.createSessionCookie() yöntemi için gerekli oturum çerezi seçeneklerini gösteren arayüz.
TotpMultiFactorProviderConfig	TOTP iki faktörlü kimlik doğrulaması için yapılandırma ayarlarını temsil eden arayüz.
UidIdentifier	Benzersiz kullanıcı kimliği ile hesap aramak için kullanılır.BaseAuth.getUsers() sayfasına bakın.
UpdatePhoneMultiFactorInfoRequest	UpdateRequest için telefona özel, kullanıcı tarafından kaydedilmiş ikinci faktörü 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ı üzerinde güncellenecek özellikleri temsil eden arayüz.
UpdateTenantRequest	Sağlanan kiracı üzerinde güncellenecek özellikleri temsil eden arayüz.
UserImportOptions	BaseAuth.importUsers() yöntemi için gereken içe aktarma seçeneklerini gösteren arayüz. Bu, şifre karma oluşturma algoritmasıyla ilgili bilgileri sağlamak için kullanılır.
UserImportRecord	BaseAuth.importUsers() yöntemiyle Firebase Auth'a içe aktarma işlemini temsil eden kullanıcıyı temsil eden arayüz.
UserImportResult	Kullanıcıları Firebase Auth'a toplu olarak içe aktarmak için BaseAuth.importUsers() yönteminin yanıtını gösteren arayüz.
UserMetadataRequest	Bir kullanıcı içe aktarılırken dahil edilecek kullanıcı meta verileri.
KullanıcıSağlayıcı	Bir Firebase kullanıcısıyla ilişkilendirilebilecek 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.

Tür Takma Adları

Takma Ad yazın	Açıklama
AuthFactorType	İkinci faktör türünü tanımlar.
AuthProviderConfig	Yetkilendirme sağlayıcısı yapılandırma türü. BaseAuth.createProviderConfig() kodunu kullanın.
CreateMultiFactorInfoRequest	CreateRequest için kullanıcının kayıtlı ikinci faktör özelliklerini temsil eden tür.
CreateTenantRequest	Yeni bir kiracıda ayarlanacak özellikleri temsil eden arayüz.
HashAlgorithmType
MultiFactorConfigState	Çok öğeli yapılandırma durumunu tanımlar.
PasswordPolicyPolicyZorunluluk	Şifre politikasının zorunlu kılma durumu.
Recaptchaİşlemi	reCAPTCHA korumalı istekler için yapılacak işlemler. - "BLOCK": reCAPTCHA korumalı istek engellenir.
RecaptchaKeyClientType	Anahtarın platform türü.
RecaptchaProviderEnforcementState	reCAPTCHA korumasının yaptırım durumu. - 'KAPALI': Uygulanmadı. - "DENETLE": Değerlendirme oluşturun ancak sonucu zorunlu kılmayın. - "ENFORCE" (ENFORCE): Değerlendirme oluşturun ve sonucu uygulayın.
SmsRegionConfig	SMS Region Config'in güncellenmesi için kullanılan 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 göre belirlenir.
UpdateAuthProviderRequest
UpdateMultiFactorInfoRequest	UpdateRequest için kullanıcının kayıtlı ikinci faktör ö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şkilendirilmiş 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	Uygulama

Şunu döndürür:

Yetkilendirme

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ğrulayıcı Türü

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

İmza:

export type AuthFactorType = 'phone';

AuthProviderConfig

Yetkilendirme sağlayıcısı yapılandırma türü. BaseAuth.createProviderConfig() kodunu kullanın.

İmza:

export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;

CreateMultiFactorInfoRequest

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

İmza:

export type CreateMultiFactorInfoRequest = CreatePhoneMultiFactorInfoRequest;

CreateTenantRequest Oluştur

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

İmza:

export type CreateTenantRequest = UpdateTenantRequest;

HashAlgorithmType

İ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';

PasswordPolicyImplementState

Şifre politikasının zorunlu kılma durumu.

İmza:

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

Özet İşlemi

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

İmza:

export type RecaptchaAction = 'BLOCK';

Özet AnahtarıİstemciTürü

Anahtarın platform türü.

İmza:

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

RecaptchaProviderImplementState

reCAPTCHA korumasının yaptırım durumu. - 'KAPALI': Uygulanmadı. - "DENETLE": Değerlendirme oluşturun ancak sonucu zorunlu kılmayın. - "ENFORCE" (ENFORCE): Değerlendirme oluşturun ve sonucu uygulayın.

İmza:

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

SmsRegionConfig

SMS Region Config'in güncellenmesi için kullanılan 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 göre belirlenir.

İmza:

export type SmsRegionConfig = AllowByDefaultWrap | AllowlistOnlyWrap;

UpdateAuthProviderRequest

İmza:

export type UpdateAuthProviderRequest = SAMLUpdateAuthProviderRequest | OIDCUpdateAuthProviderRequest;

MultiFactorInfoRequest Güncelleme

UpdateRequest için kullanıcının kayıtlı ikinci faktör ö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;