Auth ve TenantAwareAuth API'leri için ortak üst arayüz.
İmza:
export declare abstract class BaseAuth
Yöntemler
| Yöntem | Değiştiriciler | Açıklama |
|---|---|---|
| createCustomToken(uid, developerClaims) | İstemci SDK'larıyla oturum açmak için kullanılacak istemci cihazına geri gönderilebilecek yeni bir Firebase özel jetonu (JWT) oluşturur signInWithCustomToken() yöntem. (Kiracıya duyarlı örnekler, jetona kiracı kimliğini de yerleştirir.)Kod örnekleri ve ayrıntılı belgeler için Özel Jeton oluşturma bölümüne bakın. |
|
| createProviderConfig(config) | Yeni sağlayıcı yapılandırması oluşturulduğunda, yeni oluşturulan AuthProviderConfig ile çözümlenen bir taahhüt döndürür.SAML ve OIDC sağlayıcı desteği için Google Cloud'un Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın. |
|
| createSessionCookie(idToken, sessionCookieOptions) | Belirtilen seçeneklerle yeni bir Firebase oturum çerezi oluşturur. Oluşturulan JWT dizesi, özel çerez politikasına sahip sunucu tarafı oturum çerezi olarak ayarlanabilir ve oturum yönetimi için kullanılabilir. Oturum çerezi JWT'si, sağlanan kimlik jetonuyla aynı yük hak taleplerine sahip olur.Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Yönetme bölümüne bakın. | |
| createUser(properties) | Yeni bir kullanıcı oluşturur.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı oluşturma konusuna bakın. | |
| deleteProviderConfig(providerId) | İletilen sağlayıcı kimliğine karşılık gelen sağlayıcı yapılandırmasını siler. Belirtilen kimlik mevcut değilse auth/configuration-not-found hatası verilir.SAML ve OIDC sağlayıcı desteği için Google Cloud'un Kimlik Platformu (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın. |
|
| deleteUser(uid) | Mevcut bir kullanıcıyı siler.Kod örnekleri ve ayrıntılı dokümanlar için Kullanıcı silme başlıklı makaleyi inceleyin. | |
| deleteUsers(uids) | Belirtilen kullanıcı kimlikleri tarafından belirtilen kullanıcıları siler.Mevcut olmayan bir kullanıcının silinmesi hata oluşmasına neden olmaz (yani bu yöntem idempotenttir.) Mevcut olmayan kullanıcılar başarıyla silinmiş olarak kabul edilir ve bu nedenle DeleteUsersResult.successCount değerine dahil edilir.En fazla 1.000 tanımlayıcı sağlanabilir. 1.000'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError gönderir.Bu API şu anda sunucuda 1 QPS ile sınırlandırılmıştır. Bu sınırı aşarsanız kota aşıldı hatası alabilirsiniz. Bu nedenle, 1.000'den fazla kullanıcı silmek istiyorsanız bu sınırı aşmamak için bir gecikme süresi eklemeniz gerekebilir. |
|
| generateEmailDoğrulamaLink(e-posta, actionCodeSettings) | Kullanıcının belirtilen e-posta üzerindeki sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar. | |
| generatePasswordResetLink(e-posta, actionCodeSettings) | Bir kullanıcının şifresini sıfırlamak için bant dışı e-posta işlem bağlantısını oluşturur. Bağlantı, belirtilen e-posta adresine sahip kullanıcı için oluşturulur. İsteğe bağlı ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar. | |
| generateSignInWithEmailLink(e-posta, actionCodeSettings) | Kullanıcının belirtilen e-posta üzerindeki sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar. | |
| generateVerifyAndChangeEmailLink(e-posta, yeniE-posta, actionCodeSettings) | Kullanıcının belirtilen e-posta üzerinde sahibi olduğunu doğrulamak için bant dışı e-posta işlemi bağlantısı oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar. | |
| getProviderConfig(providerId) | Sağlanan kimliğe göre bir Auth sağlayıcı yapılandırması arar. Belirtilen sağlayıcı kimliğine karşılık gelen sağlayıcı yapılandırmasıyla çözümlenen bir taahhüt döndürür. Belirtilen kimlik mevcut değilse auth/configuration-not-found hatası verilir.SAML ve OIDC sağlayıcı desteği için Google Cloud'un Kimlik Platformu (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın. |
|
| getUser(uid) | Belirli bir uid öğesine karşılık gelen kullanıcıya ait kullanıcı verilerini alır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleyi inceleyin. |
|
| getUserByEmail(e-posta) | Belirli bir e-postaya karşılık gelen kullanıcıya ait kullanıcı verilerini alır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleyi inceleyin. | |
| getUserByPhoneNumber(phoneNumber) - | Belirli bir telefon numarasına karşılık gelen kullanıcıya ait kullanıcı verilerini alır. Telefon numarasının E.164 spesifikasyonuna uygun olması gerekir.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakın. | |
| getUserByProviderUid(providerId, uid) | Belirli bir sağlayıcı kimliğine karşılık gelen kullanıcıya ait kullanıcı verilerini alır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleyi inceleyin. | |
| getUsers(tanımlayıcılar) | Belirtilen tanımlayıcılara karşılık gelen kullanıcı verilerini alır.Sipariş garantisi verilmez; özellikle, sonuç listesindeki n'inci girişin, giriş parametreleri listesindeki n'inci girişe karşılık geleceği garanti edilmez.En fazla 100 tanımlayıcı sağlanabilir. 100'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError hatası verir. | |
| importUsers(kullanıcılar, seçenekler) | Sağlanan kullanıcı listesini Firebase Auth'a aktarır. Tek seferde en fazla 1.000 kullanıcının içe aktarılmasına izin verilir. Şifresi olan kullanıcıları içe aktarırken UserImportOptions'ın belirtilmesi gerekir. Bu işlem toplu içe aktarma işlemleri için optimize edilmiştir ve yinelemelere neden olabilecek uid, email ve diğer tanımlayıcı benzersizliğiyle ilgili kontrolleri yoksayar. |
|
| listProviderConfigs(options) | Sağlanan filtreyle eşleşen mevcut sağlayıcı yapılandırmalarının listesini döndürür. Aynı anda en fazla 100 sağlayıcı yapılandırması listelenebilir.SAML ve OIDC sağlayıcı desteği için Google Cloud'un Kimlik Platformu (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın. | |
| listUsers(maxResults, pageToken) | pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda kullanıcıların listesini (yalnızca tekli grup) alır. Belirli bir projenin tüm kullanıcılarını gruplar halinde almak için kullanılır.Kod örnekleri ve ayrıntılı belgeler için Tüm kullanıcıları listeleme sayfasına göz atın. |
|
| revokeRefreshTokens(uid) | Mevcut bir kullanıcının tüm yenileme jetonlarını iptal eder.Bu API, kullanıcının UserRecord.tokensValidAfterTime değerini, geçerli UTC'ye göre günceller. Bu çağrının çağrıldığı sunucunun saatinin doğru şekilde ayarlanması ve senkronize edilmesi önemlidir.Bu işlem, belirtilen kullanıcı için tüm oturumları iptal eder ve mevcut oturumlar için yeni kimlik jetonlarının basılmasını devre dışı bırakırken, mevcut kimlik jetonları doğal kullanımları sona erene (bir saat) kadar etkin kalabilir. Kimlik jetonlarının iptal edildiğini doğrulamak için BaseAuth.verifyIdToken() komutunu kullanın (checkRevoked değeri doğru olarak ayarlanır). |
|
| setCustomUserClaims(uid, customUserClaims) | Sağlanan uid tarafından tanımlanan mevcut bir kullanıcı hakkında ek geliştirici hak talepleri ayarlar. Bu hak talepleri, genellikle kullanıcı rollerini ve erişim düzeylerini tanımlamak için kullanılır. Bu hak talepleri, kullanıcının zaten oturum açmış olduğu (jeton süresinin dolmasından sonra veya jeton yenilemesi zorunlu kılındığında) ve bir sonraki oturum açışında tüm cihazlara uygulanmalıdır. Ayrılmış bir OIDC hak talebi adı kullanılırsa (sub, iat, iss vb.) bir hata verilir. Bunlar, kimliği doğrulanmış kullanıcının kimlik jetonu JWT'sinde ayarlanır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı rollerini ve erişim düzeylerini tanımlama bölümüne bakın. |
|
| updateProviderConfig(providerId, updatedConfig) | Belirtilen sağlayıcı kimliğine karşılık gelen güncellenmiş AuthProviderConfig ile çözümlenen bir taahhüt döndürür. Belirtilen kimlik mevcut değilse auth/configuration-not-found hatası verilir.SAML ve OIDC sağlayıcı desteği için Google Cloud'un Kimlik Platformu (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın. |
|
| updateUser(uid, mülkler) | Mevcut bir kullanıcıyı günceller.Kod örnekleri ve ayrıntılı belgeler için Bir kullanıcıyı güncelleme sayfasına göz atın. | |
| verifyIdToken(idToken, checkCanceld) | Firebase kimlik jetonunu (JWT) doğrular. Jeton geçerliyse jetonun kodu çözülmüş talepleriyle taahhüt yerine getirilir; Aksi takdirde, taahhüt reddedilir.checkRevoked doğru değerine ayarlanırsa öncelikle ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular. Yanıt evet ise bir auth/user-disabled hatası verilir. Hayır ise kimlik jetonuna karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılınırsa auth/id-token-revoked hatası verilir. Belirtilmezse kontrol uygulanmaz.Kod örnekleri ve ayrıntılı belgeler için, Kimlik Jetonlarını Doğrulama bölümüne bakın. |
|
| verifySessionCookie(sessionCookie, checkCanceld) | Firebase oturum çerezini doğrular. Çerez hak talepleriyle birlikte bir Vaat döndürür. Çerez doğrulanamadıysa taahhüdü reddeder.checkRevoked doğru değerine ayarlanırsa öncelikle ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular: Evet ise auth/user-disabled hatası verilir. Hayır ise oturum çerezine karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılınırsa auth/session-cookie-revoked hatası verilir. Belirtilmezse kontrol yapılmaz.Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Doğrulama bölümüne bakın |
BaseAuth.createCustomToken()
İstemci SDK'larıyla oturum açmak için kullanılacak istemci cihazına geri gönderilebilecek yeni bir Firebase özel jetonu (JWT) oluşturur signInWithCustomToken() yöntem. (Kiracıya duyarlı örnekler, kiracı kimliğini de jetona yerleştirir.)
Kod örnekleri ve ayrıntılı belgeler için Özel Jetonlar Oluşturma bölümüne bakın.
İmza:
createCustomToken(uid: string, developerClaims?: object): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Özel jetonun konusu olarak kullanılacak uid. |
| geliştirici Talepleri | nesne | Özel jetonun yüküne dahil edilecek isteğe bağlı ek talepler. |
Şunu döndürür:
Promise<dize>
Sağlanan uid ve yük için özel jetonla gerçekleşen bir taahhüt.
BaseAuth.createProviderConfig()
Yeni sağlayıcı yapılandırması oluşturulduğunda, yeni oluşturulan AuthProviderConfig ile çözümlenen bir taahhüt döndürür.
SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
İmza:
createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| yapılandırma | AuthProviderConfig | Oluşturulacak sağlayıcı yapılandırması. |
Şunu döndürür:
Promise<AuthProviderConfig>
Oluşturulan sağlayıcı yapılandırmasıyla çözümlenen bir taahhüt.
BaseAuth.createSessionCookie()
Belirtilen seçeneklerle yeni bir Firebase oturum çerezi oluşturur. Oluşturulan JWT dizesi, özel çerez politikasına sahip sunucu tarafı oturum çerezi olarak ayarlanabilir ve oturum yönetimi için kullanılabilir. Oturum çerezi JWT'si, sağlanan kimlik jetonuyla aynı yük taleplerine sahip olacaktır.
Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Yönetme bölümüne bakın.
İmza:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| kimlikToken | dize | Oturum çerezi için kullanılacak Firebase kimliği jetonu. |
| sessionCookieOptions | SessionCookieOptions | Özel oturum süresini içeren oturum çerezi seçenekleri. |
Şunu döndürür:
Promise<dize>
Oluşturulan oturum çereziyle başarılı sonuç veren bir vaat.
BaseAuth.createUser()
Yeni bir kullanıcı oluşturur.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı oluşturma başlıklı makaleye bakın.
İmza:
createUser(properties: CreateRequest): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| mülkler | CreateRequest (İstek Oluştur) | Oluşturulacak yeni kullanıcı kaydında ayarlanacak özellikler. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Yeni oluşturulan kullanıcıya karşılık gelen kullanıcı verileriyle ilgili bir taahhüt gerçekleştirildi.
BaseAuth.deleteProviderConfig()
İletilen sağlayıcı kimliğine karşılık gelen sağlayıcı yapılandırmasını siler. Belirtilen kimlik yoksa auth/configuration-not-found hatası verilir.
SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
İmza:
deleteProviderConfig(providerId: string): Promise<void>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| sağlayıcı kimliği | dize | Silinecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği. |
Şunu döndürür:
Taahhüt<void>
Tamamlandığında sona eren bir vaat.
BaseAuth.deleteUser()
Mevcut bir kullanıcıyı siler.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı silme başlıklı makaleye göz atın.
İmza:
deleteUser(uid: string): Promise<void>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Silinecek kullanıcıya karşılık gelen uid. |
Şunu döndürür:
Taahhüt<void>
Kullanıcı silindikten sonra boş bir vaat yerine getirildi.
BaseAuth.deleteUsers()
Belirtilen kullanıcı kimlikleri tarafından belirtilen kullanıcıları siler.
Mevcut olmayan bir kullanıcının silinmesi hata oluşturmaz (yani bu yöntem idempotent). Mevcut olmayan kullanıcıların başarıyla silindiği kabul edilir ve bu nedenle bu kullanıcılar DeleteUsersResult.successCount değerine dahil edilir.
En fazla 1.000 tanımlayıcı sağlanabilir. 1.000'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError hatası verir.
Şu anda bu API'nin sunucudaki hızı 1 QPS ile sınırlıdır. Bu sınırı aşarsanız kota aşıldı hatası alabilirsiniz. Bu nedenle, 1.000'den fazla kullanıcı silmek istiyorsanız bu sınırı aşmamak için bir gecikme süresi eklemeniz gerekebilir.
İmza:
deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| Uid'ler | dize[] | Silinecek kullanıcılara karşılık gelen uids. |
Şunu döndürür:
Promise<DeleteUsersResult>
Toplam başarılı/başarısız silme işleminin sayısını ve başarısız silme işlemlerine karşılık gelen hata dizisini çözen bir Vaat.
BaseAuth.generateEmailverificationLink()
Kullanıcının belirtilen e-posta üzerindeki sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar.
İmza:
generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| e-posta | dize | Doğrulanacak e-posta hesabı. |
| işlemKodu Ayarları | ActionCodeSettings | İşlem kodu ayarları. Belirtilirse state/continue URL'si "continueUrl" olarak ayarlanır parametresini kontrol edin. Varsayılan e-posta doğrulaması açılış sayfası, uygulama yüklüyse uygulamaya geri dönülecek bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine herhangi bir URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştiricinin Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul etmesi durumunda geçerlidir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırılmışsa geçerli olur. |
Şunu döndürür:
Promise<dize>
Oluşturulan bağlantıyla çözüme ulaştırılacak bir taahhüt.
Örnek
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generatePasswordResetLink()
Bir kullanıcının şifresini sıfırlamak için bant dışı e-posta işlem bağlantısını oluşturur. Bağlantı, belirtilen e-posta adresine sahip kullanıcı için oluşturulur. İsteğe bağlı ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar.
İmza:
generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| e-posta | dize | Şifresi sıfırlanacak kullanıcının e-posta adresi. |
| işlemKodu Ayarları | ActionCodeSettings | İşlem kodu ayarları. Belirtilirse state/continue URL'si "continueUrl" olarak ayarlanır parametresini kullanabilirsiniz. Varsayılan şifre sıfırlama açılış sayfası, uygulama yüklüyse uygulamaya geri dönülecek bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine herhangi bir URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştiricinin Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul etmesi durumunda geçerlidir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırılmışsa geçerli olur. |
Şunu döndürür:
Promise<dize>
Oluşturulan bağlantıyla çözüme ulaştırılacak bir taahhüt.
Örnek
var actionCodeSettings = {
url: 'https://www.example.com/?email=user@example.com',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generatePasswordResetLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateSignInWithEmailLink()
Kullanıcının belirtilen e-posta üzerindeki sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar.
İmza:
generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| e-posta | dize | Doğrulanacak e-posta hesabı. |
| işlemKodu Ayarları | ActionCodeSettings | İşlem kodu ayarları. Belirtilmişse State/continue URL'si "continueUrl" olarak ayarlanır. parametresini kullanabilirsiniz. Varsayılan e-posta doğrulaması açılış sayfası, uygulama yüklüyse uygulamaya geri dönülecek bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine herhangi bir URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştiricinin Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul etmesi durumunda geçerlidir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırılmışsa geçerli olur. |
Şunu döndürür:
Promise<dize>
Oluşturulan bağlantıyla çözüme ulaştırılacak bir taahhüt.
Örnek
var actionCodeSettings = {
url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
iOS: {
bundleId: 'com.example.ios'
},
android: {
packageName: 'com.example.android',
installApp: true,
minimumVersion: '12'
},
handleCodeInApp: true,
dynamicLinkDomain: 'custom.page.link'
};
admin.auth()
.generateEmailVerificationLink('user@example.com', actionCodeSettings)
.then(function(link) {
// The link was successfully generated.
})
.catch(function(error) {
// Some error occurred, you can inspect the code: error.code
});
BaseAuth.generateVerifyAndChangeEmailLink()
Kullanıcının belirtilen e-posta üzerinde sahibi olduğunu doğrulamak için bant dışı e-posta işlemi bağlantısı oluşturur. Bu yönteme bağımsız değişken olarak sağlanan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama veya tarayıcı tarafından işlenip işlenmeyeceğini ve derin bağlantıda iletilecek ek durum bilgilerini vb. tanımlar.
İmza:
generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| e-posta | dize | Mevcut e-posta hesabı. |
| yeniE-posta | dize | Hesabın güncellendiği e-posta adresi. |
| işlemKodu Ayarları | ActionCodeSettings | İşlem kodu ayarları. Belirtilirse state/continue URL'si "continueUrl" olarak ayarlanır parametresini kullanabilirsiniz. Varsayılan e-posta doğrulaması açılış sayfası, uygulama yüklüyse uygulamaya geri dönülecek bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine herhangi bir URL eklenmez. Sağlanan eyalet URL'si, konsolda yetkilendirilmiş bir alan adına ait olmalıdır. Aksi takdirde hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştiricinin Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul etmesi durumunda geçerlidir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırılmışsa geçerli olur. |
Şunu döndürür:
Promise<dize>
Oluşturulan bağlantıyla çözüme ulaştırılacak bir taahhüt.
BaseAuth.getProviderConfig()
Sağlanan kimliğe göre bir Auth sağlayıcı yapılandırması arar. Belirtilen sağlayıcı kimliğine karşılık gelen sağlayıcı yapılandırmasıyla çözümlenen bir taahhüt döndürür. Belirtilen kimlik yoksa auth/configuration-not-found hatası verilir.
SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
İmza:
getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| sağlayıcı kimliği | dize | Döndürülecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği. |
Şunu döndürür:
Promise<AuthProviderConfig>
Sağlanan kimliğe karşılık gelen yapılandırmayla çözümlenen bir taahhüt.
BaseAuth.getUser()
Belirli bir uid öğesine karşılık gelen kullanıcı verilerini alır.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleye göz atın.
İmza:
getUser(uid: string): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Verileri getirilecek kullanıcıya karşılık gelen uid. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Sağlanan uid ile ilişkili kullanıcı verileriyle ilgili taahhüt.
BaseAuth.getUserByEmail()
Belirli bir e-postaya karşılık gelen kullanıcıya ait kullanıcı verilerini alır.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleye göz atın.
İmza:
getUserByEmail(email: string): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| e-posta | dize | Verileri getirilecek kullanıcıya karşılık gelen e-posta adresi. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Sağlanan e-postadaki kullanıcı verileriyle ilgili taahhüt.
BaseAuth.getUserByPhoneNumber()
Belirli bir telefon numarasına karşılık gelen kullanıcıya ait kullanıcı verilerini alır. Telefon numarası E.164 spesifikasyonuna uygun olmalıdır.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleye göz atın.
İmza:
getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| telefonNumarası | dize | Verileri getirilecek kullanıcıya karşılık gelen telefon numarası. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Sağlanan telefon numarasına karşılık gelen kullanıcı verileriyle ilgili söz.
BaseAuth.getUserByProviderUid()
Belirli bir sağlayıcı kimliğine karşılık gelen kullanıcıya ait kullanıcı verilerini alır.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma başlıklı makaleye göz atın.
İmza:
getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| sağlayıcı kimliği | dize | Sağlayıcı kimliği (ör. "google.com") Google sağlayıcı için. |
| uid | dize | Belirtilen sağlayıcının kullanıcı tanımlayıcısı. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Belirtilen sağlayıcı kimliğine karşılık gelen kullanıcı verileriyle yerine getirilen bir taahhüt.
BaseAuth.getUsers()
Belirtilen tanımlayıcılara karşılık gelen kullanıcı verilerini alır.
Sipariş garantisi verilmez, özellikle, sonuç listesindeki n'inci girişin, giriş parametreleri listesindeki n'inci girişe karşılık geleceği garanti edilmez.
En fazla 100 tanımlayıcı girilebilir. 100'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError hatası verir.
İmza:
getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| identifiers | UserIdentifier[] | Hangi kullanıcı kayıtlarının döndürülmesi gerektiğini belirtmek için kullanılan tanımlayıcılar. 100'den fazla giriş olmamalıdır. |
Şunu döndürür:
Promise<GetUsersResult>
İlgili kullanıcı kayıtları için çözümlenen bir taahhüt.
İstisnalar
FirebaseAuthError Tanımlayıcılardan herhangi biri geçersizse veya 100'den fazla tanımlayıcı belirtilmişse.
BaseAuth.importUsers()
Sağlanan kullanıcı listesini Firebase Auth'a aktarır. Tek seferde en fazla 1.000 kullanıcının içe aktarılmasına izin verilir. Şifresi olan kullanıcıları içe aktarırken UserImportOptions'ın belirtilmesi gerekir. Bu işlem toplu içe aktarma işlemleri için optimize edilmiştir ve yinelemelere neden olabilecek uid, email ve diğer tanımlayıcı benzersizliğine yönelik kontrolleri yoksayar.
İmza:
importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| kullanıcılar | UserImportRecord[] | Firebase Auth'a aktarılacak kullanıcı kayıtlarının listesi. |
| seçenekler | UserImportOptions | Sağlanan kullanıcılar şifre kimlik bilgilerini içerdiğinde zorunlu olan kullanıcı içe aktarma seçenekleri. |
Şunu döndürür:
Promise<UserImportResult>
İçe aktarma işleminin sonucuyla işlem tamamlandığında çözülecek bir taahhüt. Bu raporda başarılı içe aktarma işlemlerinin sayısı, başarısız içe aktarma işlemlerinin sayısı ve bunlarla ilgili hatalar bulunur.
BaseAuth.listProviderConfigs()
Sağlanan filtreyle eşleşen mevcut sağlayıcı yapılandırmalarının listesini döndürür. Aynı anda en fazla 100 sağlayıcı yapılandırması listelenebilir.
SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
İmza:
listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| seçenekler | AuthProviderConfigFilter | Uygulanacak sağlayıcı yapılandırma filtresi. |
Şunu döndürür:
Promise<ListProviderConfigResults>
Filtre gereksinimlerini karşılayan sağlayıcı yapılandırmalarının listesiyle sonuçlanan bir taahhüt.
BaseAuth.listUsers()
pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda kullanıcıların listesini (yalnızca tekli grup) alır. Bu, belirtilen bir projenin tüm kullanıcılarını gruplar halinde almak için kullanılır.
Kod örnekleri ve ayrıntılı belgeler için Tüm kullanıcıları listeleme bölümüne göz atın.
İmza:
listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| maxResults | sayı | Sayfa boyutu, tanımlanmamışsa 1000. Bu aynı zamanda izin verilen maksimum sınırdır. |
| pageToken | dize | Sonraki sayfa jetonu. Belirtilmezse herhangi bir ofset olmadan başlayan kullanıcıları döndürür. |
Şunu döndürür:
Promise<ListUsersResult>
Mevcut indirilen kullanıcı grubu ve sonraki sayfa jetonuyla sonuçlanacak bir taahhüt.
BaseAuth.revokeRefreshTokens()
Mevcut bir kullanıcının tüm yenileme jetonlarını iptal eder.
Bu API, kullanıcının UserRecord.tokensValidAfterTime değerini geçerli UTC'ye günceller. Sunucunun çağrıldığı sunucunun saatinin doğru şekilde ayarlanması ve senkronize edilmesi önemlidir.
Bu işlem, belirtilen bir kullanıcı için tüm oturumları iptal eder ve mevcut oturumlar için yeni kimlik jetonlarının basılmasını devre dışı bırakır. Ancak, mevcut kimlik jetonları doğal kullanımları sona erene (bir saat) kadar etkin kalabilir. Kimlik jetonlarının iptal edildiğini doğrulamak için BaseAuth.verifyIdToken() komutunu kullanın (checkRevoked değeri doğru olarak ayarlanır).
İmza:
revokeRefreshTokens(uid: string): Promise<void>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Yenileme jetonları iptal edilecek kullanıcıya karşılık gelen uid. |
Şunu döndürür:
Taahhüt<void>
Kullanıcının yenileme jetonları iptal edildiğinde boş taahhüt yerine getirildi.
BaseAuth.setCustomUserClaims()
Sağlanan uid tarafından tanımlanan mevcut bir kullanıcı hakkında ek geliştirici hak talepleri belirler. Bu haklar genellikle kullanıcı rollerini ve erişim düzeylerini tanımlamak için kullanılır. Bu hak talepleri, kullanıcının zaten oturum açmış olduğu (jeton süresinin dolmasından sonra veya jeton yenilemesi zorunlu kılındığında) ve bir sonraki oturum açışında tüm cihazlara uygulanmalıdır. Ayrılmış bir OIDC hak talebi adı kullanılırsa (sub, iat, iss vb.) bir hata verilir. Bunlar, kimliği doğrulanan kullanıcının kimlik jetonu JWT'sinde ayarlanır.
Kod örnekleri ve ayrıntılı belgeler için Kullanıcı rollerini ve erişim düzeylerini tanımlama bölümünü inceleyin.
İmza:
setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Düzenlenecek kullanıcının uid öğesi. |
| özelKullanıcıHak Talepleri | nesne | boş | Geliştirici belirlemeyi iddia ediyor. Null değeri iletilirse mevcut özel hak talepleri silinir. 1.000 bayttan büyük özel hak talebi yükünün iletilmesi hataya neden olur. Özel hak talepleri, kimliği doğrulanmış her istekte iletilen kullanıcı kimlik jetonuna eklenir. Profil erişimle ilgili olmayan kullanıcı özellikleri için veritabanı veya başka ayrı depolama sistemlerini kullanın. |
Şunu döndürür:
Taahhüt<void>
İşlem başarıyla tamamlandığında sonuçlanacak bir söz.
BaseAuth.updateProviderConfig()
Belirtilen sağlayıcı kimliğine karşılık gelen güncellenmiş AuthProviderConfig ile çözümlenen bir taahhüt döndürür. Belirtilen kimlik yoksa auth/configuration-not-found hatası verilir.
SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gereklidir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP dokümanlarına bakın.
İmza:
updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| sağlayıcı kimliği | dize | Güncellenecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği. |
| updatedConfig | UpdateAuthProviderRequest | Güncellenen yapılandırma. |
Şunu döndürür:
Promise<AuthProviderConfig>
Güncellenen sağlayıcı yapılandırmasıyla çözülecek bir söz.
BaseAuth.updateUser()
Mevcut bir kullanıcıyı günceller.
Kod örnekleri ve ayrıntılı belgeler için Bir kullanıcıyı güncelleme başlıklı makaleye göz atın.
İmza:
updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| uid | dize | Güncellenecek kullanıcıya karşılık gelen uid. |
| mülkler | Güncelleme İsteği | Sağlanan kullanıcı hakkında güncellenecek özellikler. |
Şunu döndürür:
Promise<UserRecord> (Kullanıcı Kaydı)
Güncellenen kullanıcı verileriyle gerçekleşen bir taahhüt.
BaseAuth.verifyIdToken()
Firebase kimlik jetonunu (JWT) doğrular. Jeton geçerliyse jetonun kodu çözülmüş talepleriyle taahhüt yerine getirilir; Aksi takdirde, taahhüt reddedilir.
checkRevoked Doğru değerine ayarlanırsa öncelikle ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular. Yanıt evet ise bir auth/user-disabled hatası verilir. Hayır ise kimlik jetonuna karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılınırsa auth/id-token-revoked hatası verilir. Belirtilmezse kontrol uygulanmaz.
Kod örnekleri ve ayrıntılı belgeler için Kimlik Jetonlarını Doğrulama bölümüne bakın.
İmza:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| kimlikToken | dize | Doğrulanacak kimlik jetonu. |
| checkİptal edildi | boolean | Kimlik jetonunun iptal edilip edilmediğinin kontrol edilip edilmeyeceğini belirler. Bu işlem, ilgili kullanıcının tokensValidAfterTime süresini kontrol etmek için Firebase Auth arka ucuna ek bir istek gönderilmesini gerektirir. Belirtilmediğinde bu ek kontrol uygulanmaz. |
Şunu döndürür:
Taahhüt<DecodedIdToken>
Kimlik jetonu geçerliyse jetonun kodu çözülmüş talepleriyle yerine getirilen bir taahhüt; vaatleri reddetmelisiniz.
BaseAuth.verifySessionCookie()
Firebase oturum çerezini doğrular. Çerez hak talepleriyle birlikte bir Vaat döndürür. Çerez doğrulanamadıysa talebi reddeder.
checkRevoked doğru değerine ayarlanırsa öncelikle ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular: Evet ise auth/user-disabled hatası verilir. Hayır ise oturum çerezine karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılınırsa auth/session-cookie-revoked hatası verilir. Belirtilmezse kontrol yapılmaz.
Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Doğrulama bölümüne bakın
İmza:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| sessionCookie | dize | Doğrulanacak oturum çerezi. |
| checkİptal edildi | boolean |
Şunu döndürür:
Taahhüt<DecodedIdToken>
Oturum çerezi geçerliyse, oturum çerezinin kodu çözülmüş hak talepleriyle yerine getirilen bir taahhüt; vaatleri reddetmelisiniz.