auth package

Firebase Authentication

İşlevler

İşlev	Açıklama
fonksiyon(uygulama, ...)
getAuth(uygulama)	Sağlanan FirebaseApp ile ilişkili Auth örneğini döndürür. Örnek yoksa platforma özgü varsayılan bağımlılıklarla bir Auth örneğini başlatır.
initializeAuth(uygulama, deps)	Bağımlılıklar üzerinde ayrıntılı denetimle bir Auth örneğini başlatır.
fonksiyon(depolama, ...)
getReactNativePersistence(depolama alanı)	react-native veya @react-native-community/async-storage kaynağından içe aktarılan AsyncStorage öğesini sarmalayan bir kalıcılık nesnesi döndürür ve initializeAuth() öğesindeki kalıcılık bağımlılığı alanında kullanılabilir.
function(auth, ...)
applyActionCode(auth, oobCode)	Kullanıcıya e-posta yoluyla veya bant dışı başka bir mekanizmayla gönderilen doğrulama kodunu uygular.
beforeAuthStateChanged(auth, callback, onAbort)	Bir kimlik doğrulama durumu değişikliği yeni bir kullanıcı ayarlamadan önce çalışan bir engelleme geri çağırması ekler.
checkActionCode(auth, oobCode)	Kullanıcıya e-postayla veya bant dışı başka bir mekanizmayla gönderilen doğrulama kodunu kontrol eder.
confirmPasswordReset(auth, oobCode, yeniŞifre)	Onay kodu ve yeni şifreyle şifre sıfırlama işlemini tamamlar.
connectAuthEmulator(kimlik doğrulama, url, seçenekler)	Üretimde Firebase Auth hizmetleri yerine Firebase Auth Emulator ile iletişim kurmak için Auth örneğini değiştirir.
createUserWithEmailAndPassword(kimlik doğrulama, e-posta, şifre)	Belirtilen e-posta adresi ve şifreyle ilişkili yeni bir kullanıcı hesabı oluşturur.
fetchSignInMethodsForEmail(yetkilendirme, e-posta)	Belirtilen e-posta adresi için olası oturum açma yöntemlerinin listesini alır. Bu yöntem, E-posta Numaralandırma Koruması etkinleştirildiğinde, belirtilen e-posta için kullanılabilecek kimlik doğrulama yöntemlerinin sayısından bağımsız olarak boş bir liste döndürür.
getMultiFactorÇözümleyici(kimlik doğrulama, hata)	Çok öğeli akışın tamamlanması için uygun bir MultiFactorresolver sağlar.
getRedirectResult(auth, çözümleyici)	Yönlendirmeye dayalı oturum açma akışından bir UserCredential döndürür.
initializeRecaptchaConfig(auth)	reCAPTCHA yapılandırmasını Auth örneğine yükler.
isSignInWithEmailLink(yetkilendirme, e-posta Bağlantısı)	Gelen bağlantının signInWithEmailLink() için uygun e-posta bağlantısına sahip bir oturum açma işlemi olup olmadığını kontrol eder.
onAuthStateChanged(auth, nextOrObserver, hata, tamamlandı)	Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler.
onIdTokenChanged(auth, nextOrObserver, hata, tamamlandı)	Oturum açmış kullanıcının kimlik jetonundaki değişiklikler için bir gözlemci ekler.
revokeAccessToken(yetkilendirme, jeton)	Verilen erişim jetonunu iptal eder. Şu anda yalnızca Apple OAuth erişim jetonları desteklenmektedir.
sendPasswordResetEmail(kimlik doğrulama, e-posta, actionCodeSettings)	Belirtilen e-posta adresine şifre sıfırlama e-postası gönderir. Belirtilen e-posta adresine sahip bir kullanıcı hesabı yoksa ve E-posta Numaralandırma Koruması etkinse bu yöntem hata bildirmez.
sendSignInLinkToEmail(yetkilendirme, e-posta, actionCodeSettings)	Belirtilen e-posta adresine sahip kullanıcıya bir oturum açma e-posta bağlantısı gönderir.
setPersistence(kimlik doğrulama, kalıcılık)	Şu anda kayıtlı Auth oturumu için Auth örneğinin kalıcılık türünü değiştirir ve bu kalıcılık türünü, gelecekteki oturum açma isteklerine (yönlendirme istekleriyle oturum açma da dahil) uygular.
signInAnonymous(auth)	Eşzamansız olarak anonim bir kullanıcı olarak oturum açıyor.
signInWithCredential(auth, kimlik bilgisi)	Verilen kimlik bilgileriyle eşzamansız olarak oturum açar.
signInWithCustomToken(auth, customToken)	Özel bir jeton kullanarak eşzamansız olarak oturum açar.
signInWithEmailAndPassword(kimlik doğrulama, e-posta, şifre)	E-posta ve şifre kullanarak eşzamansız olarak oturum açıyor.
signInWithEmailLink(yetkilendirme, e-posta, e-posta Bağlantısı)	E-posta ve oturum açma e-posta bağlantısını kullanarak eşzamansız olarak oturum açıyor.
signInWithPhoneNumber(yetkilendirme, telefon numarası, appVerifier)	Telefon numarası kullanarak eşzamansız olarak oturum açıyor.
signInWithPopup(yetkilendirme, sağlayıcı, çözümleyici)	Pop-up tabanlı bir OAuth kimlik doğrulama akışı kullanarak Firebase istemcisinin kimliğini doğrular.
signInWithRedirect(kimlik doğrulama, sağlayıcı, çözümleyici)	Tam sayfa yönlendirme akışı kullanarak Firebase istemcisinin kimliğini doğrular.
signOut(auth)	Geçerli kullanıcının oturumu kapatılır.
updateCurrentUser(auth, kullanıcı)	Sağlanan kullanıcıyı eşzamansız olarak Auth. örneğinde Auth.currentUser olarak ayarlar.
useDeviceLanguage(auth)	Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar.
verifyPassword(auth, şifre)	Şifreyi proje veya kiracı için yapılandırılan şifre politikasına göre doğrular.
verifyPasswordResetCode(kimlik doğrulama, kod)	Kullanıcıya e-posta veya bant dışı başka bir mekanizma ile gönderilen şifre sıfırlama kodunu kontrol eder.
fonksiyon(bağlantı, ...)
parseActionCodeURL(bağlantı)	E-posta işlemi bağlantı dizesini ayrıştırır ve bağlantı geçerliyse bir ActionCodeURL döndürür, aksi takdirde null döndürür.
function(kullanıcı, ...)
deleteUser(user)	Kullanıcıyı siler ve oturumu kapatır.
getIdToken(user, forceRefresh)	Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan bir JSON Web Jetonu (JWT) döndürür.
getIdTokenResult(user, forceRefresh)	Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token'ı (JWT) döndürür.
linkWithCredential(kullanıcı, kimlik bilgisi)	Kullanıcı hesabını verilen kimlik bilgilerine bağlar.
linkWithPhoneNumber(kullanıcı, telefonNumarası, appVerifier)	Kullanıcı hesabını belirtilen telefon numarasına bağlar.
linkWithPopup(kullanıcı, sağlayıcı, çözümleyici)	Kimliği doğrulanmış sağlayıcıyı, pop-up tabanlı bir OAuth akışı kullanarak kullanıcı hesabına bağlar.
linkWithRedirect(kullanıcı, sağlayıcı, çözümleyici)	Tam sayfa yönlendirme akışı kullanarak OAuthProvider'ı kullanıcı hesabına bağlar.
multiFactor(kullanıcı)	Kullanıcıya karşılık gelen MultiFactorUser.
reauthenticateWithCredential(kullanıcı, kimlik bilgisi)	Yeni bir kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.
reauthenticateWithPhoneNumber(kullanıcı, telefonNumarası, appVerifier)	Yeni bir telefon kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.
reauthenticateWithPopup(kullanıcı, sağlayıcı, çözümleyici)	Pop-up tabanlı bir OAuth akışı kullanarak, geçerli kullanıcının kimliğini belirtilen OAuthProvider ile yeniden doğrular.
reauthenticateWithRedirect(kullanıcı, sağlayıcı, çözümleyici)	Tam sayfa yönlendirme akışı kullanarak, geçerli kullanıcının kimliğini belirtilen OAuthProvider ile yeniden doğrular.
reload(kullanıcı)	Oturum açıldığında kullanıcı hesabı verilerini yeniden yükler.
sendEmailDoğrulama(kullanıcı, actionCodeSettings)	Kullanıcıya doğrulama e-postası gönderir.
unlink(user, providerId)	Sağlayıcının kullanıcı hesabıyla olan bağlantısını kaldırır.
updateEmail(kullanıcı, yeniE-posta)	Kullanıcının e-posta adresini günceller.
updatePassword(kullanıcı, yeniŞifre)	Kullanıcının şifresini günceller.
updatePhoneNumber(kullanıcı, kimlik bilgisi)	Kullanıcının telefon numarasını günceller.
updateProfile(kullanıcı, { displayName, photoURL: photoUrl })	Kullanıcının profil verilerini günceller.
verifyBeforeUpdateEmail(kullanıcı, yeniE-posta, actionCodeSettings)	Yeni bir e-posta adresine doğrulama e-postası gönderir.
fonksiyon(userCredential, ...)
getAdditionalUserInfo(userCredential)	Belirtilen kimlik bilgisi için sağlayıcıya özel AdditionalUserInfo'yu ayıklar.

Sınıflar

Sınıf	Açıklama
İşlem KoduURL'si	Şifre sıfırlama, e-posta doğrulaması, e-posta bağlantısıyla oturum açma gibi e-posta işlemi URL'lerini ayrıştırmak için kullanılan bir yardımcı program sınıfı.
AuthCredential	AuthProvider tarafından döndürülen kimlik bilgilerini temsil eden arayüz.
EmailAuthCredential	ProviderId için EmailAuthProvider tarafından döndürülen kimlik bilgilerini temsil eden arayüz.
EmailAuthProvider	EmailAuthCredential oluşturan sağlayıcı.
FacebookAuthProvider	ProviderId.FACEBOOK için OAuthCredential oluşturan sağlayıcı.
GitHubAuthProvider	ProviderId.GITHUB için OAuthCredential oluşturan sağlayıcı.
GoogleAuthProvider	ProviderId.GOOGLE için bir OAuthCredential oluşturan sağlayıcı.
OAuthCredential (OAuth Kimlik Bilgisi)	OAuthProvider tarafından döndürülen OAuth kimlik bilgilerini temsil eder.
OAuthProvider	Genel OAuthCredential oluşturma sağlayıcısı.
PhoneAuthCredential	PhoneAuthProvider tarafından döndürülen kimlik bilgilerini temsil eder.
PhoneAuthProvider	PhoneAuthCredential oluşturma sağlayıcısı.
PhoneMultiFactorGenerator	PhoneMultiFactorAssertion oluşturan sağlayıcı.
RecaptchaVerileyici	reCAPTCHA tabanlı bir uygulama doğrulayıcıdır.
SAMLAuthProvider	SAML için bir AuthProvider kullanabilirsiniz.
TotpMultiFactorGenerator	TotpMultiFactorAssertion oluşturma sağlayıcı.
TotpSecret	TotpMultiFactorAssertion oluşturma sağlayıcı.Zamana dayalı OTP'ler oluşturmak için paylaşılan gizli anahtarı ve diğer parametreleri depolar. Paylaşılan gizli anahtarı alma ve QR kodu URL'si oluşturma yöntemlerini uygular.
TwitterAuthProvider	ProviderId.TWITTER için OAuthCredential oluşturan sağlayıcı.

Arayüzler

Arayüz	Açıklama
ActionCodeInfo	checkActionCode() yanıtı.
ActionCodeSettings	Gerekli devam/durum URL'sini isteğe bağlı Android ve iOS paket tanımlayıcılarıyla tanımlayan bir arayüz.
Ek Kullanıcı Bilgileri	Birleştirilmiş kimlik sağlayıcıdan alınan ek kullanıcı bilgilerini içeren yapı.
ApplicationVerifier	Alan doğrulaması ve kötüye kullanımı önleme amaçlı bir doğrulayıcı.
Yetkilendirme	Firebase Auth hizmetini temsil eden arayüz.
AuthError	Arayüzde Auth hatası oluştu.
AuthErrorMap	Hata kodlarının hata mesajlarıyla eşlemesi.
AuthProvider	Kimlik doğrulama sağlayıcıyı temsil eden ve AuthCredential oluşturmayı kolaylaştırmak için kullanılan arayüzdür.
AuthSettings (Kimlik Doğrulama Ayarları)	Auth örneğinin ayarlarını temsil eden arayüz.
Yapılandırma	Auth yapılandırmasını temsil eden arayüz.
ConfirmationResult	Telefon numarasıyla oturum açma, bağlantı veya yeniden kimlik doğrulama aramasının sonucu.
Bağımlılıklar	Auth örneğini başlatmak için kullanılabilecek bağımlılıklar.
EmulatorConfig	Firebase Authentication Emulator yapılandırması.
IdTokenResult	User.getIdTokenResult() işleminden elde edilen kimlik jetonu sonucunu temsil eden arayüz.
MultiFactorAssertion	İkinci faktör sahipliği iddiasında bulunmak için kullanılan temel sınıf.
MultiFaktör Hatası	Kullanıcının başarıyla oturum açmak için ikinci bir faktör sağlaması gerektiğinde verilen hata.
MultiFactorInfo	İkinci faktör varlığa ait bilgileri içeren yapı.
MultiFaktör Çözücü	Kullanıcının oturum açmak için ikinci bir faktör sağlaması gerektiğinde MultiFactorError'dan kurtarma işlemini kolaylaştırmak için kullanılan sınıf.
MultiFaktörOturum	Bir kullanıcıda ikinci bir faktör kaydı yapmak veya kayıtlı bir kullanıcının ikinci faktör ile oturum açmasına yardımcı olmak için kullanılan çok öğeli oturum nesnesini tanımlayan arayüz.
Çok FaktörlüKullanıcı	Bir Kullanıcı'ya ait çok öğeliyle ilgili özellikleri ve işlemleri tanımlayan arayüz.
OAuthCredentialOptions	OAuthCredential (OAuthKimlik Bilgisi) başlatma seçeneklerini tanımlar.
ParsedToken	Ayrıştırılmış kimlik jetonunu temsil eden arayüz.
ŞifrePolitikası	Şifre politikası gereksinimlerini belirten bir yapı.
PasswordValidationStatus	Hangi şifre politikası şartlarının karşılandığını veya ihlal edildiğini ve şartların neler olduğunu gösteren yapı.
Kararlılık	Olası kalıcılık mekanizması türlerini ele alan bir arayüz.
TelefonMultiFactorAssertion	Telefon ikinci faktör sahipliği iddiasında bulunan sınıf. PhoneMultiFactorGenerator.assertion() tarafından sağlanmıştır.
PhoneMultiFactorEnrollmentInfoOptions	İkinci faktör kaydı için kullanılan seçenekler.
TelefonMultiFactorInfo	Telefon numarasının ikinci faktörleri için MultiFactorInfo arayüzünün alt sınıfı. Bu ikinci faktörün factorId değeri FaktörId.PHONE'dur.
PhoneMultiFactorSignInInfoOptions	İkinci faktörle oturum açmak için kullanılan seçenekler.
PhoneSingleFactorInfoOptions	Tek faktörlü oturum açma için kullanılan seçenekler.
Pop-upRedirectÇözümleyici	signInWithPopup() veya signInWithRedirect() gibi DOM'ye özel işlemleri işlemek için kullanılan bir çözümleyici.
ReactNativeAsyncStorage	Sağlanan AsyncStorage için arayüz.
RecaptchaParameters	reCAPTCHA parametrelerini temsil eden arayüz.Kabul edilen parametrelerin listesi için reCAPTCHA belgelerine bakın. sitekey haricindeki tüm parametreler kabul edilir: Firebase Auth, her proje için bir reCAPTCHA sağlar ve oluşturma işleminden sonra site anahtarını yapılandırır.Görünmez bir reCAPTCHA için size anahtarını invisible olarak ayarlayın.
TotpMultiFactorAssertion	TOTP ikinci faktör sahipliği iddiasında bulunmak için kullanılan sınıf. TotpMultiFactorGenerator.assertionForEnrollment() ve TotpMultiFactorGenerator.assertionForSignIn() tarafından sağlanır.
TotpMultiFactorInfo	TOTP ikinci faktörler için MultiFactorInfo arayüzünün alt sınıfı. Bu ikinci faktörün factorId değeri FactorId.TOTP'dir.
Kullanıcı	Kullanıcı hesabı.
UserCredential (Kullanıcı Kimlik Bilgisi)	User, OperationType ve sağlayıcı kimliğini içeren bir yapı.
Kullanıcı Bilgileri	Yalnızca Firebase projesinin uygulamaları tarafından görülebilen kullanıcı profili bilgileri.
KullanıcıMeta Verileri	Kullanıcının meta verilerini temsil eden arayüz.

Değişkenler

Değişken	Açıklama
ActionCodeOperation	Olası e-posta işlemi türlerinin listesi.
AuthErrorCode'lar	SDK'nın oluşturduğu hatalarla daha kolay karşılaştırma yapmayı sağlayan, olası Auth hata kodlarının haritası.
browserLocalPersistence	Temel depolama alanı için localStorage kullanarak LOCAL türündeki Kalıcı uygulaması.
browserPopupRedirectÇözümleyici	Tarayıcı tabanlı uygulamalar için uygun bir PopupRedirect çözümr uygulaması.
browserSessionPersistence	Temel depolama alanı olarak sessionStorage kullanarak SESSION kalıcı uygulaması.
cordovaPopupRedirect çözümleyici	Cordova tabanlı uygulamalara uygun bir PopupRedirect çözümr uygulaması.
debugErrorMap	Çoğu hata kodu için ayrıntılı açıklamaları içeren ayrıntılı bir hata haritası.AuthErrorMap’teki tartışmaya bakabilirsiniz.
Faktör Kimliği	Çok öğeli kimlik doğrulaması için kullanılabilecek faktörlerin listesi.
indexedDBLocalPersistence	Temel depolama alanı için indexedDB kullanarak LOCAL türündeki Kalıcı uygulaması.
InMemoryPersistence	"HİÇBİRİ" türündeki Kalıcı uygulaması.
İşlem Türü	Desteklenen işlem türlerinin listesi.
üretken hata haritası	Tüm ayrıntılı hata mesajlarının çıkarıldığı minimum hata haritası.Tartışmaya AuthErrorMap'ten bakabilirsiniz.
Sağlayıcı Kimliği	Desteklenen sağlayıcıların listesi.
SignInMethod	Desteklenen oturum açma yöntemlerinin listesi.

Tür Takma Adları

Takma Ad yazın	Açıklama
CustomParameters (Özel Parametreler)	OAuth özel parametreleri haritası.
NextOrGözlemci	Etkinlik geri çağırması için tür tanımı.
PhoneInfoOptions	Bir telefon numarasının sahipliğini doğrulamak için gereken bilgiler.
UserProfile	AdditionalUserInfo'da kullanılan kullanıcı profili.

function(uygulama; ...)

getAuth(uygulama)

Sağlanan FirebaseApp ile ilişkili Auth örneğini döndürür. Örnek yoksa platforma özgü varsayılan bağımlılıklarla bir Auth örneğini başlatır.

İmza:

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

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması	Firebase Uygulaması.

Şunu döndürür:

Yetkilendirme

startizeAuth(uygulama; deps)

Bağımlılıklar üzerinde ayrıntılı denetimle bir Auth örneğini başlatır.

Bu işlev, Auth örneği üzerinde getAuth() işlevine göre daha fazla kontrol sağlar. getAuth, bağımlılıkları sağlamak için platforma özel varsayılan ayarları kullanır. Genel olarak getAuth, Auth'u başlatmanın en kolay yoludur ve çoğu kullanım alanında işe yarar. Hangi kalıcılık katmanının kullanılacağı konusunda kontrole ihtiyacınız varsa initializeAuth kullanın. signInWithPopup ya da signInWithRedirect kullanmıyorsanız paket boyutunu en aza indirin.

Örneğin, uygulamanız yalnızca anonim hesaplar kullanıyorsa ve yalnızca geçerli oturum için hesapların kaydedilmesini istiyorsanız Auth öğesini şununla başlatın:

const auth = initializeAuth(app, {
  persistence: browserSessionPersistence,
  popupRedirectResolver: undefined,
});

İmza:

export declare function initializeAuth(app: FirebaseApp, deps?: Dependencies): Auth;

Parametreler

Parametre	Tür	Açıklama
uygulama	FirebaseUygulaması
kalkış noktaları	Bağımlılıklar

Şunu döndürür:

Yetkilendirme

function(depolama; ...)

getReactNativePersistence(depolama alanı)

react-native veya @react-native-community/async-storage kaynağından içe aktarılan AsyncStorage öğesini sarmalayan bir kalıcılık nesnesi döndürür ve initializeAuth() işlevindeki kalıcı bağımlılık alanında kullanılabilir.

İmza:

export declare function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;

Parametreler

Parametre	Tür	Açıklama
depolama	ReactNativeAsyncStorage

Şunu döndürür:

Kararlılık

function(yetkilendirme; ...)

applyActionCode(auth, oobCode)

Kullanıcıya e-posta yoluyla veya bant dışı başka bir mekanizmayla gönderilen doğrulama kodunu uygular.

İmza:

export declare function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
oobKodu	dize	Kullanıcıya gönderilen bir doğrulama kodu.

Şunu döndürür:

Taahhüt<void>

beforeAuthStateChanged(kimlik doğrulama, geri çağırma, onAbort)

Bir kimlik doğrulama durumu değişikliği yeni bir kullanıcı ayarlamadan önce çalışan bir engelleme geri çağırması ekler.

İmza:

export declare function beforeAuthStateChanged(auth: Auth, callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
geri çağırma	(kullanıcı: Kullanıcı | null) => geçersiz | Taahhüt<void>	yeni kullanıcı değeri ayarlanmadan önce geri çağırma tetiklendi. Bu uyarı yayınlanırsa kullanıcının ayarlanması engellenir.
onİptal	() => geçersiz	Daha sonra bir beforeAuthStateChanged() geri çağırması yapılırsa geri çağırma tetiklenerek yan etkileri geri almanıza olanak tanır.

Şunu döndürür:

E-posta listesinden çık

checkActionCode(auth, oobCode)

Kullanıcıya e-postayla veya bant dışı başka bir mekanizmayla gönderilen doğrulama kodunu kontrol eder.

İmza:

export declare function checkActionCode(auth: Auth, oobCode: string): Promise<ActionCodeInfo>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
oobKodu	dize	Kullanıcıya gönderilen bir doğrulama kodu.

Şunu döndürür:

Promise<ActionCodeInfo>

ve kodla ilgili meta verileri içerir.

onayŞifresiSıfırla(kimlik doğrulama, oobCode, yeniŞifre)

Onay kodu ve yeni şifreyle şifre sıfırlama işlemini tamamlar.

İmza:

export declare function confirmPasswordReset(auth: Auth, oobCode: string, newPassword: string): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
oobKodu	dize	Kullanıcıya gönderilen bir onay kodu.
yeniŞifre	dize	Yeni şifre.

Şunu döndürür:

Taahhüt<void>

connectAuthEmulator(kimlik doğrulama, url, seçenekler)

Üretimde Firebase Auth hizmetleri yerine Firebase Auth Emulator ile iletişim kurmak için Auth örneğini değiştirir.

Bu, initializeAuth() çağrısından hemen sonra eşzamanlı olarak çağrılmalıdır. Emülatör trafiği şifrelenmediğinden üretim kimlik bilgileriyle kullanmayın.

İmza:

export declare function connectAuthEmulator(auth: Auth, url: string, options?: {
    disableWarnings: boolean;
}): void;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
url	dize	Emülatörün çalıştırıldığı URL (ör. "http://localhost:9099").
seçenekler	{disableAlerts: boole; }	İsteğe bağlı. options.disableWarnings, varsayılan olarak false değerine ayarlıdır. DOM'ye ekli uyarı banner'ını devre dışı bırakmak için etiketi true olarak ayarlayın.

Şunu döndürür:

geçersiz

Örnek

connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });

createUserWithEmailAndPassword(kimlik doğrulama; e-posta; şifre)

Belirtilen e-posta adresi ve şifreyle ilişkili yeni bir kullanıcı hesabı oluşturur.

Bu kullanıcı, kullanıcı hesabı başarıyla oluşturulduktan sonra uygulamanızda da oturum açacaktır.

Hesap zaten mevcutsa veya şifre geçersizse kullanıcı hesabı oluşturulamaz.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örneklerinde desteklenmez.

Not: E-posta adresi, kullanıcı için benzersiz bir tanımlayıcı görevi görür ve e-posta tabanlı şifre sıfırlama işlemine olanak tanır. Bu işlev yeni bir kullanıcı hesabı oluşturur ve ilk kullanıcı şifresini belirler.

İmza:

export declare function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta	dize	Kullanıcının e-posta adresi.
şifre	dize	Kullanıcının seçtiği şifre.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

receiveSignInMethodsForEmail(yetkilendirme, e-posta)

Belirtilen e-posta adresi için olası oturum açma yöntemlerinin listesini alır. Bu yöntem, E-posta Numaralandırma Koruması etkinleştirildiğinde, belirtilen e-posta için kullanılabilecek kimlik doğrulama yöntemlerinin sayısından bağımsız olarak boş bir liste döndürür.

Bu, aynı sağlayıcı için oturum açma yöntemlerini ayırt etmek açısından faydalıdır (ör. EmailAuthProvider: 2 oturum açma yöntemi vardır: SignInMethod.EMAIL_LEVEL ve SignInMethod.EMAIL_LINK.

İmza:

export declare function fetchSignInMethodsForEmail(auth: Auth, email: string): Promise<string[]>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta	dize	Kullanıcının e-posta adresi.Kullanımdan kaldırıldı. Güvenlikle ilgili en iyi uygulama olarak bu yöntemin kapatılması önerilir. E-posta Numaralandırma Koruması'nın Identity Platform dokümanlarında daha fazla bilgi bulabilirsiniz.

Şunu döndürür:

Promise&lt;string[]&gt;

getMultiFactorresolver(kimlik doğrulama, hata)

Çok öğeli akışın tamamlanması için uygun bir MultiFactorresolver sağlar.

İmza:

export declare function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
hata	MultiFaktör Hatası	Oturum açma veya yeniden kimlik doğrulama işlemi sırasında ortaya çıkan MultiFactorError.

Şunu döndürür:

MultiFaktör Çözücü

getRedirectResult(yetkilendirme, çözümleyici)

Yönlendirmeye dayalı oturum açma akışından bir UserCredential döndürür.

Oturum açma başarılı olursa oturum açmış kullanıcıyı döndürür. Oturum açma başarısız olduysa bir hata döndürerek başarısız olur. Herhangi bir yönlendirme işlemi çağrılmamışsa null değerini döndürür.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Promise<UserCredential | null>

Örnek

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

startizeRecaptchaConfig(auth)

reCAPTCHA yapılandırmasını Auth örneğine yükler.

Bu işlem, mevcut Auth oturumuna her bir kimlik doğrulama sağlayıcı için reCAPTCHA doğrulama akışının tetiklenip tetiklenmeyeceğini gösteren reCAPTCHA yapılandırmasını yükler.

initializeRecaptchaConfig() çağrılmazsa yetkilendirme akışı her zaman reCAPTCHA doğrulaması olmadan başlar. Sağlayıcı reCAPTCHA doğrulaması gerektirecek şekilde yapılandırılmışsa SDK, reCAPTCHA yapılandırmasını şeffaf olarak yükler ve kimlik doğrulama akışlarını yeniden başlatır.

Dolayısıyla, bu isteğe bağlı yöntemi çağırarak gelecekteki kimlik doğrulama akışlarının gecikmesini azaltabilirsiniz. reCAPTCHA yapılandırmasını erken yüklemek de reCAPTCHA tarafından toplanan sinyali iyileştirir.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

export declare function initializeRecaptchaConfig(auth: Auth): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.

Şunu döndürür:

Taahhüt<void>

Örnek

initializeRecaptchaConfig(auth);

isSignInWithEmailLink(yetkilendirme, e-posta Bağlantısı)

Gelen bağlantının signInWithEmailLink() için uygun e-posta bağlantısına sahip bir oturum açma işlemi olup olmadığını kontrol eder.

İmza:

export declare function isSignInWithEmailLink(auth: Auth, emailLink: string): boolean;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta Bağlantısı	dize	Bağlantı, kullanıcının e-posta adresine gönderilir.

Şunu döndürür:

boolean

onAuthStateChanged(auth, nextOrObserver, hata, tamamlandı)

Kullanıcının oturum açma durumundaki değişiklikler için bir gözlemci ekler.

Eski davranışı korumak için onIdTokenChanged() işlevini inceleyin.

İmza:

export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
sonrakiOrGözlemci	NextOrObserver<Kullanıcı>	değişiklikten sonra geri çağırma tetiklendi.
hata	HataFn	Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez. Oturum açma/kapatma sırasında yapılan hatalar, oturum açma/oturum kapatma işlevlerinden döndürülen vaatlerde fark edilebilir.
tamamlandı	TamamlaFn	Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez.

Şunu döndürür:

E-posta listesinden çık

onIdTokenChanged(auth, nextOrObserver, hata, tamamlandı)

Oturum açmış kullanıcının kimlik jetonundaki değişiklikler için bir gözlemci ekler.

Buna oturum açma, oturum kapatma ve jeton yenileme etkinlikleri dahildir. Bu işlem, kimlik jetonunun süresi dolduğunda otomatik olarak tetiklenmez. Kimlik jetonunu yenilemek için User.getIdToken() kullanın.

İmza:

export declare function onIdTokenChanged(auth: Auth, nextOrObserver: NextOrObserver<User>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
sonrakiOrGözlemci	NextOrObserver<Kullanıcı>	değişiklikten sonra geri çağırma tetiklendi.
hata	HataFn	Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez. Oturum açma/kapatma sırasında yapılan hatalar, oturum açma/oturum kapatma işlevlerinden döndürülen vaatlerde fark edilebilir.
tamamlandı	TamamlaFn	Kullanımdan kaldırıldı. Bu geri çağırma hiçbir zaman tetiklenmez.

Şunu döndürür:

E-posta listesinden çık

cancelAccessToken(yetkilendirme, jeton)

Verilen erişim jetonunu iptal eder. Şu anda yalnızca Apple OAuth erişim jetonları desteklenmektedir.

İmza:

export declare function revokeAccessToken(auth: Auth, token: string): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
token	dize	Apple OAuth erişim jetonu.

Şunu döndürür:

Taahhüt<void>

sendPasswordResetEmail(kimlik doğrulama, e-posta, actionCodeSettings)

Belirtilen e-posta adresine şifre sıfırlama e-postası gönderir. Belirtilen e-posta adresine sahip bir kullanıcı hesabı yoksa ve E-posta Numaralandırma Koruması etkinse bu yöntem hata bildirmez.

Şifre sıfırlama işlemini tamamlamak için kullanıcıya gönderilen e-postada verilen kod ve kullanıcının belirttiği yeni şifre ile confirmPasswordReset() işlevini çağırın.

İmza:

export declare function sendPasswordResetEmail(auth: Auth, email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta	dize	Kullanıcının e-posta adresi.
işlemKodu Ayarları	ActionCodeSettings	ActionCodeSettings.

Şunu döndürür:

Taahhüt<void>

Örnek

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendPasswordResetEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain code from user.
await confirmPasswordReset('[e-mail]', code);

sendSignInLinkToEmail(yetkilendirme, e-posta, actionCodeSettings)

Belirtilen e-posta adresine sahip kullanıcıya bir oturum açma e-posta bağlantısı gönderir.

Oturum açma işleminin, diğer bant dışı e-posta işlemlerinin (şifre sıfırlama ve e-posta doğrulamaları) aksine her zaman uygulamada tamamlanması gerekir. Bunun nedeni, akışın sonunda kullanıcının oturum açmasının beklendiği ve Yetki durumunun uygulamada devam ediyor olmasıdır.

E-posta bağlantısıyla oturum açma işlemini tamamlamak için kullanıcıya gönderilen e-postada sağlanan e-posta adresi ve e-posta bağlantısını kullanarak signInWithEmailLink() çağrısı yapın.

İmza:

export declare function sendSignInLinkToEmail(auth: Auth, email: string, actionCodeSettings: ActionCodeSettings): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme
e-posta	dize	Kullanıcının e-posta adresi.
işlemKodu Ayarları	ActionCodeSettings	ActionCodeSettings.

Şunu döndürür:

Taahhüt<void>

Örnek

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, '[e-mail]', emailLink);
}

setPersistence(kimlik doğrulama, kalıcılık)

Şu anda kayıtlı Auth oturumu için Auth örneğinin kalıcılık türünü değiştirir ve bu kalıcılık türünü, gelecekteki oturum açma isteklerine (yönlendirme istekleriyle oturum açma da dahil) uygular.

Bu, oturum açan bir kullanıcının oturumunun hatırlanıp hatırlanmayacağını belirtmesini kolaylaştırır. Ayrıca, diğer kullanıcılar tarafından paylaşılan veya hassas veriler içeren uygulamalar için Auth durumunun hiçbir zaman kalıcı olmamasını da kolaylaştırır.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function setPersistence(auth: Auth, persistence: Persistence): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
sebat	Kararlılık	Kullanılacak Kalıcılık.

Şunu döndürür:

Taahhüt<void>

Kalıcılık değişikliği tamamlandığında çözümlenen bir Promise

Örnek

setPersistence(auth, browserSessionPersistence);

signInAnonymous(auth)

Eşzamansız olarak anonim bir kullanıcı olarak oturum açıyor.

Halihazırda anonim bir kullanıcı oturum açmışsa bu kullanıcı döndürülür. Aksi takdirde yeni bir anonim kullanıcı kimliği oluşturulur ve döndürülür.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

export declare function signInAnonymously(auth: Auth): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

signInWithCredential(kimlik doğrulama, kimlik bilgisi)

Verilen kimlik bilgileriyle eşzamansız olarak oturum açar.

Kimlik bilgisini oluşturmak için AuthProvider kullanılabilir.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

export declare function signInWithCredential(auth: Auth, credential: AuthCredential): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
yeterlilik belgesi	AuthCredential	Yetkilendirme kimlik bilgisi.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

signInWithCustomToken(kimlik doğrulama, customToken)

Özel bir jeton kullanarak eşzamansız olarak oturum açar.

Özel jetonlar, Firebase Auth'u mevcut kimlik doğrulama sistemleriyle entegre etmek için kullanılır ve Yönetici SDK'sındaki createCustomToken yöntemi kullanılarak bir kimlik doğrulama arka ucu tarafından oluşturulmalıdır .

Jeton geçersizse, süresi dolmuş veya Firebase Auth hizmeti tarafından kabul edilmediyse hata mesajı verir.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

export declare function signInWithCustomToken(auth: Auth, customToken: string): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
customToken	dize	Oturum açmak için kullanılacak özel jeton.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

signInWithEmailAndPassword(kimlik doğrulama; e-posta; şifre)

E-posta ve şifre kullanarak eşzamansız olarak oturum açıyor.

E-posta adresi ve şifre eşleşmiyorsa hata mesajı görüntülenir. E-posta Numaralandırma Koruması etkinleştirildiğinde bu yöntem "auth/geçersiz-kimligi" ile başarısız olur. geçersiz bir e-posta adresi/şifre kullanmaması durumunda.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örneklerinde desteklenmez.

Not: Kullanıcının şifresi, kullanıcının e-posta hesabına erişmek için kullanılan şifre DEĞİLDİR. E-posta adresi, kullanıcı için benzersiz bir tanımlayıcı işlevi görür ve şifre, Firebase projenizdeki kullanıcının hesabına erişmek için kullanılır. Ayrıca bkz: createUserWithEmailAndPassword().

İmza:

export declare function signInWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta	dize	Kullanıcının e-posta adresi.
şifre	dize	Kullanıcının şifresi.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

signInWithEmailLink(yetkilendirme; e-posta; e-posta Bağlantısı)

E-posta ve oturum açma e-posta bağlantısını kullanarak eşzamansız olarak oturum açıyor.

Hiçbir bağlantı iletilmezse bağlantı, mevcut URL'den belirlenir.

E-posta adresi geçersizse veya e-posta bağlantısındaki OTP'nin süresi dolarsa hata vererek başarısız olur.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

Not: Bu yöntemi firebase.auth.Auth.isSignInWithEmailLink'i çağırmadan önce bağlantının bir oturum açma e-posta bağlantısı olduğunu onaylayın.

İmza:

export declare function signInWithEmailLink(auth: Auth, email: string, emailLink?: string): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
e-posta	dize	Kullanıcının e-posta adresi.
e-posta Bağlantısı	dize	Bağlantı, kullanıcının e-posta adresine gönderilir.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

Örnek

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendSignInLinkToEmail(auth, '[e-mail]', actionCodeSettings);
// Obtain emailLink from the user.
if(isSignInWithEmailLink(auth, emailLink)) {
  await signInWithEmailLink(auth, '[e-mail]', emailLink);
}

signInWithPhoneNumber(yetkilendirme, telefon numarası, appVerifier)

Telefon numarası kullanarak eşzamansız olarak oturum açıyor.

Bu yöntem, belirtilen telefon numarasına SMS ile bir kod gönderir ve bir ConfirmationResult değerini döndürür. Kullanıcı, telefonuna gönderilen kodu sağladıktan sonra, kullanıcının oturum açmasını sağlamak için kodu içeren ConfirmationResult.confirm() yöntemini çağırın.

Kötüye kullanımın önlenmesi için bu yöntem bir ApplicationVerifier gerektirir. Bu SDK, reCAPTCHA tabanlı RecaptchaVerifier uygulaması içerir. Bu işlev, RecaptchaVerifier'ı desteklemeyen diğer platformlarda (React Native gibi) çalışabilir, ancak üçüncü taraf bir ApplicationVerifier uygulaması kullanmanız gerekir.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function signInWithPhoneNumber(auth: Auth, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
telefonNumarası	dize	Kullanıcının E.164 biçimindeki telefon numarası (ör. [phone]).
uygulamaDoğrulayıcı	ApplicationVerifier	ApplicationVerifier.

Şunu döndürür:

Promise<ConfirmationResult>

Örnek

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container');
const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain a verificationCode from the user.
const credential = await confirmationResult.confirm(verificationCode);

signInWithPopup(kimlik doğrulama, sağlayıcı, çözümleyici)

Pop-up tabanlı bir OAuth kimlik doğrulama akışı kullanarak Firebase istemcisinin kimliğini doğrular.

Başarılı olursa, sağlayıcının kimlik bilgileriyle birlikte oturum açmış kullanıcıyı döndürür. Oturum açma başarısız olduysa hatayla ilgili ek bilgiler içeren bir hata nesnesi döndürür.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function signInWithPopup(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

Örnek

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Facebook Access Token.
const credential = provider.credentialFromResult(auth, result);
const token = credential.accessToken;

signInWithRedirect(kimlik doğrulama, sağlayıcı, çözümleyici)

Tam sayfa yönlendirme akışı kullanarak Firebase istemcisinin kimliğini doğrular.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesine bakın. signInWithRedirect() kullanırken en iyi uygulamaları izleyin.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function signInWithRedirect(auth: Auth, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Söz verme<hiçbir zaman>

Örnek

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
// You can add additional scopes to the provider:
provider.addScope('user_birthday');
// Start a sign in process for an unauthenticated user.
await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
if (result) {
  // This is the signed-in user
  const user = result.user;
  // This gives you a Facebook Access Token.
  const credential = provider.credentialFromResult(auth, result);
  const token = credential.accessToken;
}
// As this API can be used for sign-in, linking and reauthentication,
// check the operationType to determine what triggered this redirect
// operation.
const operationType = result.operationType;

signOut(yetkilendirme)

Geçerli kullanıcının oturumu kapatılır.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

export declare function signOut(auth: Auth): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.

Şunu döndürür:

Taahhüt<void>

updateCurrentUser(yetkilendirme; kullanıcı)

Sağlanan kullanıcıyı eşzamansız olarak Auth. örneğinde Auth.currentUser olarak ayarlar.

Kullanıcının sağlanan yeni bir örnek kopyası oluşturulur ve currentUser olarak ayarlanır.

Bu, diğer oturum açma yöntemleri gibi onAuthStateChanged() ve onIdTokenChanged() işleyicilerini tetikler.

Güncellenecek kullanıcı farklı bir Firebase projesine aitse işlem başarısız olur.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından desteklenmez.

İmza:

export declare function updateCurrentUser(auth: Auth, user: User | null): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
kullanıcı	Kullanıcı | boş	Yeni Kullanıcı.

Şunu döndürür:

Taahhüt<void>

useDeviceLanguage(auth)

Geçerli dili varsayılan cihaz/tarayıcı tercihine ayarlar.

İmza:

export declare function useDeviceLanguage(auth: Auth): void;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.

Şunu döndürür:

geçersiz

VerifyPassword(kimlik doğrulama, şifre)

Şifreyi proje veya kiracı için yapılandırılan şifre politikasına göre doğrular.

Auth örneğinde kiracı kimliği ayarlanmadıysa bu yöntem, proje için yapılandırılan şifre politikasını kullanır. Aksi takdirde, bu yöntem kiracı için yapılandırılan politikayı kullanır. Bir şifre politikası yapılandırılmadıysa tüm projeler için yapılandırılan varsayılan politika kullanılır.

Gönderilen bir şifre, şifre politikası gereksinimlerini karşılamadığı için kimlik doğrulama akışı başarısız olursa ve bu yöntem daha önce çağrılmışsa, bu yöntem tekrar çağrıldığında mevcut en son politikayı kullanır.

İmza:

export declare function validatePassword(auth: Auth, password: string): Promise<PasswordValidationStatus>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
şifre	dize	Doğrulanacak şifre.

Şunu döndürür:

Promise<PasswordValidationStatus>

Örnek

validatePassword(auth, 'some-password');

VerifyPasswordResetCode(kimlik doğrulama, kod)

Kullanıcıya e-posta veya bant dışı başka bir mekanizma ile gönderilen şifre sıfırlama kodunu kontrol eder.

İmza:

export declare function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;

Parametreler

Parametre	Tür	Açıklama
auth	Yetkilendirme	Auth örneği.
kod	dize	Kullanıcıya gönderilen bir doğrulama kodu.

Şunu döndürür:

Promise<dize>

Kullanıcının e-posta adresi geçerliyse.

function(bağlantı; ...)

parseActionCodeURL(bağlantı)

E-posta işlemi bağlantı dizesini ayrıştırır ve bağlantı geçerliyse bir ActionCodeURL döndürür, aksi takdirde null döndürür.

İmza:

export declare function parseActionCodeURL(link: string): ActionCodeURL | null;

Parametreler

Parametre	Tür	Açıklama
bağlantı	dize

Şunu döndürür:

ActionCodeURL | boş

function(kullanıcı; ...)

deleteUser(kullanıcı)

Kullanıcıyı siler ve oturumu kapatır.

Önemli: Bu, kullanıcının yakın zamanda oturum açmasını gerektiren, güvenlik açısından hassas bir işlemdir. Bu koşul karşılanmazsa kullanıcıdan kimlik doğrulamasını tekrar yapmasını isteyin ve ardından reauthenticateWithCredential() çağrısını yapın.

İmza:

export declare function deleteUser(user: User): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.

Şunu döndürür:

Taahhüt<void>

getIdToken(kullanıcı, forceRefresh)

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan bir JSON Web Jetonu (JWT) döndürür.

Süresi dolmamışsa veya süresi önümüzdeki beş dakika içinde bitmeyecekse mevcut jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

export declare function getIdToken(user: User, forceRefresh?: boolean): Promise<string>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
zorla yenileme	boolean	Jetonun geçerlilik süresi ne olursa olsun zorunlu yenileme.

Şunu döndürür:

Promise<dize>

getIdTokenResult(kullanıcı, forceRefresh)

Kullanıcıyı Firebase hizmetine tanımlamak için kullanılan, seri durumdan çıkarılmış JSON Web Token'ı (JWT) döndürür.

Süresi dolmamışsa veya süresi önümüzdeki beş dakika içinde bitmeyecekse mevcut jetonu döndürür. Aksi takdirde, jeton yenilenir ve yeni bir jeton döndürülür.

İmza:

export declare function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<IdTokenResult>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
zorla yenileme	boolean	Jetonun geçerlilik süresi ne olursa olsun zorunlu yenileme.

Şunu döndürür:

Promise<IdTokenResult>

linkWithCredential(kullanıcı, kimlik bilgisi)

Kullanıcı hesabını verilen kimlik bilgilerine bağlar.

Kimlik bilgisini oluşturmak için AuthProvider kullanılabilir.

İmza:

export declare function linkWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeterlilik belgesi	AuthCredential	Yetkilendirme kimlik bilgisi.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

linkWithPhoneNumber(kullanıcı, telefonNumarası, appVerifier)

Kullanıcı hesabını belirtilen telefon numarasına bağlar.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

export declare function linkWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
telefonNumarası	dize	Kullanıcının E.164 biçimindeki telefon numarası (ör. [phone]).
uygulamaDoğrulayıcı	ApplicationVerifier	ApplicationVerifier.

Şunu döndürür:

Promise<ConfirmationResult>

linkWithPopup(kullanıcı, sağlayıcı, çözümleyici)

Kimliği doğrulanmış sağlayıcıyı, pop-up tabanlı bir OAuth akışı kullanarak kullanıcı hesabına bağlar.

Bağlama işlemi başarılı olursa döndürülen sonuç kullanıcının ve sağlayıcının kimlik bilgilerini içerir.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

export declare function linkWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

Örnek

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a popup.
const provider = new FacebookAuthProvider();
await linkWithPopup(result.user, provider);

linkWithRedirect(kullanıcı, sağlayıcı, çözümleyici)

Tam sayfa yönlendirme akışı kullanarak OAuthProvider'ı kullanıcı hesabına bağlar.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesine bakın. linkWithRedirect() kullanırken en iyi uygulamalardan yararlanın.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function linkWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Söz verme<hiçbir zaman>

Örnek

// Sign in using some other provider.
const result = await signInWithEmailAndPassword(auth, email, password);
// Link using a redirect.
const provider = new FacebookAuthProvider();
await linkWithRedirect(result.user, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

çoklu öğe(kullanıcı)

Kullanıcıya karşılık gelen MultiFactorUser.

Bu, kullanıcıyla ilgili tüm çok öğeli özelliklere ve işlemlere erişmek için kullanılır.

İmza:

export declare function multiFactor(user: User): MultiFactorUser;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.

Şunu döndürür:

Çok FaktörlüKullanıcı

reauthenticateWithCredential(kullanıcı, kimlik bilgisi)

Yeni bir kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.

Son oturum açma denemelerine ait jetonları gerektiren updatePassword() gibi işlemlerden önce kullanın. Bu yöntem, CREDENTIAL_TOO_OLD_LOGIN_AGAIN hatalarını veya TOKEN_EXPIRED hatalarını kurtarmak için kullanılabilir.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açan hiçbir User için desteklenmez.

İmza:

export declare function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeterlilik belgesi	AuthCredential	Yetkilendirme kimlik bilgisi.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

reauthenticateWithPhoneNumber(kullanıcı, telefonNumarası, appVerifier)

Yeni bir telefon kimlik bilgisi kullanarak kullanıcının kimliğini yeniden doğrular.

Son oturum açma denemelerine ait jetonları gerektiren updatePassword() gibi işlemlerden önce kullanın.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örneklerinden birinde oturum açılmış kullanıcı ile çalışmaz.

İmza:

export declare function reauthenticateWithPhoneNumber(user: User, phoneNumber: string, appVerifier: ApplicationVerifier): Promise<ConfirmationResult>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
telefonNumarası	dize	Kullanıcının E.164 biçimindeki telefon numarası (ör. [phone]).
uygulamaDoğrulayıcı	ApplicationVerifier	ApplicationVerifier.

Şunu döndürür:

Promise<ConfirmationResult>

reauthenticateWithPopup(kullanıcı, sağlayıcı, çözümleyici)

Pop-up tabanlı bir OAuth akışı kullanarak, geçerli kullanıcının kimliğini belirtilen OAuthProvider ile yeniden doğrular.

Yeniden kimlik doğrulama başarılı olursa döndürülen sonuç kullanıcının ve sağlayıcının kimlik bilgilerini içerir.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örneklerinden birinde oturum açılmış kullanıcı ile çalışmaz.

İmza:

export declare function reauthenticateWithPopup(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<UserCredential>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Promise<UserCredential> (Kullanıcı Kimlik Bilgisi)

Örnek

// Sign in using a popup.
const provider = new FacebookAuthProvider();
const result = await signInWithPopup(auth, provider);
// Reauthenticate using a popup.
await reauthenticateWithPopup(result.user, provider);

reauthenticateWithRedirect(kullanıcı, sağlayıcı, çözümleyici)

Tam sayfa yönlendirme akışı kullanarak, geçerli kullanıcının kimliğini belirtilen OAuthProvider ile yeniden doğrular.

Bu işlemin sonuçlarını ve hatalarını işlemek için getRedirectResult() öğesine bakın. reauthenticateWithRedirect() kullanırken en iyi uygulamaları izleyin.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örnekleriyle çalışmaz.

İmza:

export declare function reauthenticateWithRedirect(user: User, provider: AuthProvider, resolver?: PopupRedirectResolver): Promise<never>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
sağlayıcı	AuthProvider	Kimlik doğrulaması yapılacak sağlayıcı. Sağlayıcının bir OAuthProvider olması gerekir. EmailAuthProvider gibi OAuth olmayan sağlayıcılar hata verir.
çözümleyici	Pop-upRedirectÇözümleyici	Önceden initializeAuth() işlevine veya getAuth() tarafından sağlanmışsa isteğe bağlı bir PopupRedirectsolutionsr örneği.

Şunu döndürür:

Söz verme<hiçbir zaman>

Örnek

// Sign in using a redirect.
const provider = new FacebookAuthProvider();
const result = await signInWithRedirect(auth, provider);
// This will trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);
// Reauthenticate using a redirect.
await reauthenticateWithRedirect(result.user, provider);
// This will again trigger a full page redirect away from your app

// After returning from the redirect when your app initializes you can obtain the result
const result = await getRedirectResult(auth);

yeniden yükle(kullanıcı)

Oturum açıldığında kullanıcı hesabı verilerini yeniden yükler.

İmza:

export declare function reload(user: User): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.

Şunu döndürür:

Taahhüt<void>

sendEmailDoğrulama(kullanıcı, actionCodeSettings)

Kullanıcıya doğrulama e-postası gönderir.

Doğrulama işlemi, applyActionCode() çağrısı yapılarak tamamlanır.

İmza:

export declare function sendEmailVerification(user: User, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
işlemKodu Ayarları	ActionCodeSettings | boş	ActionCodeSettings.

Şunu döndürür:

Taahhüt<void>

Örnek

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await sendEmailVerification(user, actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

link(kullanıcı, providerId)

Sağlayıcının kullanıcı hesabıyla olan bağlantısını kaldırır.

İmza:

export declare function unlink(user: User, providerId: string): Promise<User>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
sağlayıcı kimliği	dize	Bağlantısı kaldırılacak sağlayıcı.

Şunu döndürür:

Promise<Kullanıcı>

güncellemeE-postası(kullanıcı, yeniE-posta)

Kullanıcının e-posta adresini günceller.

Hesabın ele geçirilmesini önlemek için e-posta adresi değişikliğinin iptal edilmesine olanak tanıyan orijinal e-posta adresine (ayarlanmışsa) bir e-posta gönderilir.

Bu yöntem, FirebaseServerApp ile oluşturulan Auth örnekleri tarafından oturum açan hiçbir User için desteklenmez.

Önemli: Bu, kullanıcının yakın zamanda oturum açmasını gerektiren, güvenlik açısından hassas bir işlemdir. Bu koşul karşılanmazsa kullanıcıdan kimlik doğrulamasını tekrar yapmasını isteyin ve ardından reauthenticateWithCredential() çağrısını yapın.

İmza:

export declare function updateEmail(user: User, newEmail: string): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeniE-posta	dize	Yeni e-posta adresi."auth/operation-not-allowed" ifadesini atar E-posta Numaralandırma Koruması etkinleştirildiğinde hata oluşur. Kullanımdan kaldırıldı - Bunun yerine verifyBeforeUpdateEmail() işlevini kullanın.

Şunu döndürür:

Taahhüt<void>

güncellemeŞifresi(kullanıcı, yeniŞifre)

Kullanıcının şifresini günceller.

Önemli: Bu, kullanıcının yakın zamanda oturum açmasını gerektiren, güvenlik açısından hassas bir işlemdir. Bu koşul karşılanmazsa kullanıcıdan kimlik doğrulamasını tekrar yapmasını isteyin ve ardından reauthenticateWithCredential() çağrısını yapın.

İmza:

export declare function updatePassword(user: User, newPassword: string): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeniŞifre	dize	Yeni şifre.

Şunu döndürür:

Taahhüt<void>

updatePhoneNumber(kullanıcı, kimlik bilgisi)

Kullanıcının telefon numarasını günceller.

Bu yöntem, Node.js ortamında veya FirebaseServerApp ile oluşturulan Auth örneklerinden birinde oturum açılmış kullanıcı ile çalışmaz.

İmza:

export declare function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeterlilik belgesi	PhoneAuthCredential	Yeni telefon numarasının kimliğini doğrulayan bir kimlik bilgisi.

Şunu döndürür:

Taahhüt<void>

Örnek

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('[phone]', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
await updatePhoneNumber(user, phoneCredential);

updateProfile(kullanıcı, { displayName, photoURL: photoUrl })

Kullanıcının profil verilerini günceller.

İmza:

export declare function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
    displayName?: string | null;
    photoURL?: string | null;
}): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
{ displayName, PhotoURL: fotoURL }	{ displayName?: dize | null; fotoğrafURL?: dize | null; }

Şunu döndürür:

Taahhüt<void>

VerifyBeforeUpdateEmail(kullanıcı, yeniE-posta, actionCodeSettings)

Yeni bir e-posta adresine doğrulama e-postası gönderir.

Kullanıcının e-posta adresi, doğrulandıktan sonra yeni e-posta adresiyle güncellenir.

Özel bir e-posta işlem işleyiciniz varsa applyActionCode() yöntemini çağırarak doğrulama işlemini tamamlayabilirsiniz.

İmza:

export declare function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCodeSettings?: ActionCodeSettings | null): Promise<void>;

Parametreler

Parametre	Tür	Açıklama
kullanıcı	Kullanıcı	Kullanıcı.
yeniE-posta	dize	Güncellemeden önce doğrulanacak yeni e-posta adresi.
işlemKodu Ayarları	ActionCodeSettings | boş	ActionCodeSettings.

Şunu döndürür:

Taahhüt<void>

Örnek

const actionCodeSettings = {
  url: 'https://www.example.com/?email=[e-mail]',
  iOS: {
     bundleId: 'com.example.ios'
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12'
  },
  handleCodeInApp: true
};
await verifyBeforeUpdateEmail(user, '[e-mail]', actionCodeSettings);
// Obtain code from the user.
await applyActionCode(auth, code);

function(userCredential, ...)

getAdditionalUserInfo(userCredential)

Belirtilen kimlik bilgisi için sağlayıcıya özel AdditionalUserInfo'yu ayıklar.

İmza:

export declare function getAdditionalUserInfo(userCredential: UserCredential): AdditionalUserInfo | null;

Parametreler

Parametre	Tür	Açıklama
kullanıcıKimlik Bilgisi	UserCredential (Kullanıcı Kimlik Bilgisi)	Kullanıcının kimlik bilgisi.

Şunu döndürür:

AdditionalUserInfo | boş

ActionCodeOperation

Olası e-posta işlemi türlerinin listesi.

İmza:

ActionCodeOperation: {
    readonly EMAIL_SIGNIN: "EMAIL_SIGNIN";
    readonly PASSWORD_RESET: "PASSWORD_RESET";
    readonly RECOVER_EMAIL: "RECOVER_EMAIL";
    readonly REVERT_SECOND_FACTOR_ADDITION: "REVERT_SECOND_FACTOR_ADDITION";
    readonly VERIFY_AND_CHANGE_EMAIL: "VERIFY_AND_CHANGE_EMAIL";
    readonly VERIFY_EMAIL: "VERIFY_EMAIL";
}

Kimlik Doğrulama Hataları

SDK'nın oluşturduğu hatalarla daha kolay karşılaştırma yapmayı sağlayan, olası Auth hata kodlarının haritası.

Haritadaki tuşları tek tek sallayamayacağınızdan, haritayı kullanarak paketinizin boyutunu önemli ölçüde artırabileceğinizi unutmayın.

İmza:

AUTH_ERROR_CODES_MAP_DO_NOT_USE_INTERNALLY: {
    readonly ADMIN_ONLY_OPERATION: "auth/admin-restricted-operation";
    readonly ARGUMENT_ERROR: "auth/argument-error";
    readonly APP_NOT_AUTHORIZED: "auth/app-not-authorized";
    readonly APP_NOT_INSTALLED: "auth/app-not-installed";
    readonly CAPTCHA_CHECK_FAILED: "auth/captcha-check-failed";
    readonly CODE_EXPIRED: "auth/code-expired";
    readonly CORDOVA_NOT_READY: "auth/cordova-not-ready";
    readonly CORS_UNSUPPORTED: "auth/cors-unsupported";
    readonly CREDENTIAL_ALREADY_IN_USE: "auth/credential-already-in-use";
    readonly CREDENTIAL_MISMATCH: "auth/custom-token-mismatch";
    readonly CREDENTIAL_TOO_OLD_LOGIN_AGAIN: "auth/requires-recent-login";
    readonly DEPENDENT_SDK_INIT_BEFORE_AUTH: "auth/dependent-sdk-initialized-before-auth";
    readonly DYNAMIC_LINK_NOT_ACTIVATED: "auth/dynamic-link-not-activated";
    readonly EMAIL_CHANGE_NEEDS_VERIFICATION: "auth/email-change-needs-verification";
    readonly EMAIL_EXISTS: "auth/email-already-in-use";
    readonly EMULATOR_CONFIG_FAILED: "auth/emulator-config-failed";
    readonly EXPIRED_OOB_CODE: "auth/expired-action-code";
    readonly EXPIRED_POPUP_REQUEST: "auth/cancelled-popup-request";
    readonly INTERNAL_ERROR: "auth/internal-error";
    readonly INVALID_API_KEY: "auth/invalid-api-key";
    readonly INVALID_APP_CREDENTIAL: "auth/invalid-app-credential";
    readonly INVALID_APP_ID: "auth/invalid-app-id";
    readonly INVALID_AUTH: "auth/invalid-user-token";
    readonly INVALID_AUTH_EVENT: "auth/invalid-auth-event";
    readonly INVALID_CERT_HASH: "auth/invalid-cert-hash";
    readonly INVALID_CODE: "auth/invalid-verification-code";
    readonly INVALID_CONTINUE_URI: "auth/invalid-continue-uri";
    readonly INVALID_CORDOVA_CONFIGURATION: "auth/invalid-cordova-configuration";
    readonly INVALID_CUSTOM_TOKEN: "auth/invalid-custom-token";
    readonly INVALID_DYNAMIC_LINK_DOMAIN: "auth/invalid-dynamic-link-domain";
    readonly INVALID_EMAIL: "auth/invalid-email";
    readonly INVALID_EMULATOR_SCHEME: "auth/invalid-emulator-scheme";
    readonly INVALID_IDP_RESPONSE: "auth/invalid-credential";
    readonly INVALID_LOGIN_CREDENTIALS: "auth/invalid-credential";
    readonly INVALID_MESSAGE_PAYLOAD: "auth/invalid-message-payload";
    readonly INVALID_MFA_SESSION: "auth/invalid-multi-factor-session";
    readonly INVALID_OAUTH_CLIENT_ID: "auth/invalid-oauth-client-id";
    readonly INVALID_OAUTH_PROVIDER: "auth/invalid-oauth-provider";
    readonly INVALID_OOB_CODE: "auth/invalid-action-code";
    readonly INVALID_ORIGIN: "auth/unauthorized-domain";
    readonly INVALID_PASSWORD: "auth/wrong-password";
    readonly INVALID_PERSISTENCE: "auth/invalid-persistence-type";
    readonly INVALID_PHONE_NUMBER: "auth/invalid-phone-number";
    readonly INVALID_PROVIDER_ID: "auth/invalid-provider-id";
    readonly INVALID_RECIPIENT_EMAIL: "auth/invalid-recipient-email";
    readonly INVALID_SENDER: "auth/invalid-sender";
    readonly INVALID_SESSION_INFO: "auth/invalid-verification-id";
    readonly INVALID_TENANT_ID: "auth/invalid-tenant-id";
    readonly MFA_INFO_NOT_FOUND: "auth/multi-factor-info-not-found";
    readonly MFA_REQUIRED: "auth/multi-factor-auth-required";
    readonly MISSING_ANDROID_PACKAGE_NAME: "auth/missing-android-pkg-name";
    readonly MISSING_APP_CREDENTIAL: "auth/missing-app-credential";
    readonly MISSING_AUTH_DOMAIN: "auth/auth-domain-config-required";
    readonly MISSING_CODE: "auth/missing-verification-code";
    readonly MISSING_CONTINUE_URI: "auth/missing-continue-uri";
    readonly MISSING_IFRAME_START: "auth/missing-iframe-start";
    readonly MISSING_IOS_BUNDLE_ID: "auth/missing-ios-bundle-id";
    readonly MISSING_OR_INVALID_NONCE: "auth/missing-or-invalid-nonce";
    readonly MISSING_MFA_INFO: "auth/missing-multi-factor-info";
    readonly MISSING_MFA_SESSION: "auth/missing-multi-factor-session";
    readonly MISSING_PHONE_NUMBER: "auth/missing-phone-number";
    readonly MISSING_SESSION_INFO: "auth/missing-verification-id";
    readonly MODULE_DESTROYED: "auth/app-deleted";
    readonly NEED_CONFIRMATION: "auth/account-exists-with-different-credential";
    readonly NETWORK_REQUEST_FAILED: "auth/network-request-failed";
    readonly NULL_USER: "auth/null-user";
    readonly NO_AUTH_EVENT: "auth/no-auth-event";
    readonly NO_SUCH_PROVIDER: "auth/no-such-provider";
    readonly OPERATION_NOT_ALLOWED: "auth/operation-not-allowed";
    readonly OPERATION_NOT_SUPPORTED: "auth/operation-not-supported-in-this-environment";
    readonly POPUP_BLOCKED: "auth/popup-blocked";
    readonly POPUP_CLOSED_BY_USER: "auth/popup-closed-by-user";
    readonly PROVIDER_ALREADY_LINKED: "auth/provider-already-linked";
    readonly QUOTA_EXCEEDED: "auth/quota-exceeded";
    readonly REDIRECT_CANCELLED_BY_USER: "auth/redirect-cancelled-by-user";
    readonly REDIRECT_OPERATION_PENDING: "auth/redirect-operation-pending";
    readonly REJECTED_CREDENTIAL: "auth/rejected-credential";
    readonly SECOND_FACTOR_ALREADY_ENROLLED: "auth/second-factor-already-in-use";
    readonly SECOND_FACTOR_LIMIT_EXCEEDED: "auth/maximum-second-factor-count-exceeded";
    readonly TENANT_ID_MISMATCH: "auth/tenant-id-mismatch";
    readonly TIMEOUT: "auth/timeout";
    readonly TOKEN_EXPIRED: "auth/user-token-expired";
    readonly TOO_MANY_ATTEMPTS_TRY_LATER: "auth/too-many-requests";
    readonly UNAUTHORIZED_DOMAIN: "auth/unauthorized-continue-uri";
    readonly UNSUPPORTED_FIRST_FACTOR: "auth/unsupported-first-factor";
    readonly UNSUPPORTED_PERSISTENCE: "auth/unsupported-persistence-type";
    readonly UNSUPPORTED_TENANT_OPERATION: "auth/unsupported-tenant-operation";
    readonly UNVERIFIED_EMAIL: "auth/unverified-email";
    readonly USER_CANCELLED: "auth/user-cancelled";
    readonly USER_DELETED: "auth/user-not-found";
    readonly USER_DISABLED: "auth/user-disabled";
    readonly USER_MISMATCH: "auth/user-mismatch";
    readonly USER_SIGNED_OUT: "auth/user-signed-out";
    readonly WEAK_PASSWORD: "auth/weak-password";
    readonly WEB_STORAGE_UNSUPPORTED: "auth/web-storage-unsupported";
    readonly ALREADY_INITIALIZED: "auth/already-initialized";
    readonly RECAPTCHA_NOT_ENABLED: "auth/recaptcha-not-enabled";
    readonly MISSING_RECAPTCHA_TOKEN: "auth/missing-recaptcha-token";
    readonly INVALID_RECAPTCHA_TOKEN: "auth/invalid-recaptcha-token";
    readonly INVALID_RECAPTCHA_ACTION: "auth/invalid-recaptcha-action";
    readonly MISSING_CLIENT_TYPE: "auth/missing-client-type";
    readonly MISSING_RECAPTCHA_VERSION: "auth/missing-recaptcha-version";
    readonly INVALID_RECAPTCHA_VERSION: "auth/invalid-recaptcha-version";
    readonly INVALID_REQ_TYPE: "auth/invalid-req-type";
}

tarayıcıLocalPersistence

Temel depolama alanı için localStorage kullanarak LOCAL türündeki Kalıcı uygulaması.

İmza:

browserLocalPersistence: Persistence

TarayıcıPop-upRedirectÇözümleyici

Tarayıcı tabanlı uygulamalar için uygun bir PopupRedirect çözümr uygulaması.

Bu yöntem Node.js ortamında çalışmaz.

İmza:

browserPopupRedirectResolver: PopupRedirectResolver

tarayıcıOturum kalıcılığı

Temel depolama alanı olarak sessionStorage kullanarak SESSION kalıcı uygulaması.

İmza:

browserSessionPersistence: Persistence

CordovaPopupRedirectÇözümleyici

Cordova tabanlı uygulamalara uygun bir PopupRedirect çözümr uygulaması.

İmza:

cordovaPopupRedirectResolver: PopupRedirectResolver

hata ayıklamahatasıharitası

Çoğu hata kodu için ayrıntılı açıklamalar içeren ayrıntılı bir hata haritası.

AuthError Map sayfasındaki tartışmaya göz atın.

İmza:

debugErrorMap: AuthErrorMap

FaktörNo

Çok öğeli kimlik doğrulaması için kullanılabilecek faktörlerin listesi.

İmza:

FactorId: {
    readonly PHONE: "phone";
    readonly TOTP: "totp";
}

indexDBLocalPersistence

Temel depolama alanı için indexedDB kullanarak LOCAL türündeki Kalıcı uygulaması.

İmza:

indexedDBLocalPersistence: Persistence

BellekKalıcı

"HİÇBİRİ" türündeki Kalıcı uygulaması.

İmza:

inMemoryPersistence: Persistence

OperationType

Desteklenen işlem türlerinin listesi.

İmza:

OperationType: {
    readonly LINK: "link";
    readonly REAUTHENTICATE: "reauthenticate";
    readonly SIGN_IN: "signIn";
}

ürün hatası haritası

Tüm ayrıntılı hata mesajlarının kaldırıldığı minimum hata haritası.

AuthError Map sayfasındaki tartışmaya göz atın.

İmza:

prodErrorMap: AuthErrorMap

Sağlayıcı Kimliği

Desteklenen sağlayıcıların listesi.

İmza:

ProviderId: {
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PASSWORD: "password";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

Oturum Açma Yöntemi

Desteklenen oturum açma yöntemlerinin listesi.

İmza:

SignInMethod: {
    readonly EMAIL_LINK: "emailLink";
    readonly EMAIL_PASSWORD: "password";
    readonly FACEBOOK: "facebook.com";
    readonly GITHUB: "github.com";
    readonly GOOGLE: "google.com";
    readonly PHONE: "phone";
    readonly TWITTER: "twitter.com";
}

CustomParameters (Özel Parametreler)

OAuth özel parametreleri haritası.

İmza:

export declare type CustomParameters = Record<string, string>;

SonrakiveyaGözlem Sunucusu

Etkinlik geri çağırması için tür tanımı.

İmza:

export declare type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;

Telefon BilgisiSeçenekleri

Bir telefon numarasının sahipliğini doğrulamak için gereken bilgiler.

Gerekli olan bilgiler; tek öğeli oturum açma, çok öğeli kayıt veya çok öğeli oturum açma işlemlerinden hangisini yaptığınıza bağlıdır.

İmza:

export declare type PhoneInfoOptions = PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions;

UserProfile

AdditionalUserInfo'da kullanılan kullanıcı profili.

İmza:

export declare type UserProfile = Record<string, unknown>;