BaseAuth class

Hem Auth hem de 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ının signInWithCustomToken() yöntemleriyle oturum açmak için kullanmak üzere istemci cihazına geri gönderilebilecek yeni bir Firebase özel jetonu (JWT) oluşturur. (Kiracıya duyarlı örnekler de kiracı kimliğini jetona 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 söz döndürür.SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.
createSessionCookie(idToken, sessionCookieOptions) Belirtilen seçeneklerle yeni bir Firebase oturum çerezi oluşturur. Oluşturulan JWT dizesi, özel bir çerez politikasıyla sunucu tarafı oturum çerezi olarak ayarlanabilir ve oturum yönetimi için kullanılabilir. Oturum çerezi JWT, sağlanan kimlik jetonuyla aynı yük taleplerine sahip olur.Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Yönetme bölümünü inceleyin.
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 yoksa auth/configuration-not-found hatası verilir.SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.
deleteUser(uid) Mevcut bir kullanıcıyı siler.Kod örnekleri ve ayrıntılı belgeler için Bir kullanıcıyı 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 hataya neden olmaz (yani bu yöntem eş değersizdir). 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ı girilebilir. 1.000'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError döndürür.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 eklemeniz gerekebilir.
generateEmailVerificationLink(e-posta, actionCodeSettings) Kullanıcının belirtilen e-posta adresinin sahibi olduğunu doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yöntemin bağımsız değişkeni 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 adresiyle 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 adresinin sahibi olduğunu doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yöntemin bağımsız değişkeni 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-postanın sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısı oluşturur. Bu yöntemin bağımsız değişkeni 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 söz 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) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.
getUser(uid) 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 bölümüne bakın.
getUserByEmail(e-posta) Belirli bir e-postaya karşılık gelen kullanıcı verilerini alır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakın.
getUserByPhoneNumber(phoneNumber) Belirli bir telefon numarasına karşılık gelen kullanıcıya ilişkin 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 bölümüne bakın.
getUserByProviderUid(providerId, uid) Belirli bir sağlayıcı kimliğine karşılık gelen kullanıcı verilerini alır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakın.
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.Yalnızca en fazla 100 tanımlayıcı sağlanabilir. 100'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError döndürür.
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ılırken UserImportOptions belirtilmesi gerekir. Bu işlem, toplu içe aktarma işlemleri için optimize edilmiştir ve uid, email ve yinelemelere neden olabilecek diğer tanımlayıcı benzersizliği kontrollerini 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 Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.
listUsers(maxResults, pageToken) pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda bir kullanıcı listesi (yalnızca tek grup) alır. Bu işlev, belirtilen projenin tüm kullanıcılarını toplu olarak almak için kullanılır.Kod örnekleri ve ayrıntılı belgeler için Tüm kullanıcıları listeleme sayfasını inceleyin.
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ünceller. Bu adın çağrıldığı sunucunun saatinin doğru bir şekilde ayarlanmış ve senkronize edilmiş olması önemlidir.Bu işlem, belirtilen kullanıcının tüm oturumlarını iptal edecek ve mevcut oturumlardaki yeni kimlik jetonlarının basılmasını devre dışı bıraksa da mevcut kimlik jetonları, kullanım süreleri dolana kadar (bir saat) etkin kalabilir. Kimlik jetonlarının iptal edildiğini doğrulamak için BaseAuth.verifyIdToken() işlevini kullanın. Burada checkRevoked, true olarak ayarlanır.
setCustomUserClaims(uid, customUserClaims) Sağlanan uid ile tanımlanan mevcut bir kullanıcıyla ilgili geliştirici hak taleplerini ayarlar. 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 (jetonun süresinin dolmasından sonra veya jetonun yenilenmesi zorunlu kılındığında) ve kullanıcının bir sonraki oturum açışında tüm cihazlara yayılmalıdır. Ayrılmış bir OIDC hak talebi adı kullanılırsa (sub, iat, iss vb.) bir hata verilir. Kimliği doğrulanmış kullanıcının kimlik jetonu JWT'de ayarlanır.Kod örnekleri ve ayrıntılı belgeler için Kullanıcı rollerini ve erişim düzeylerini tanımlama başlıklı makaleyi inceleyin.
updateProviderConfig(providerId, updatedConfig) Belirtilen sağlayıcı kimliğine karşılık gelen güncellenmiş AuthProviderConfig ile çözümlenen bir söz 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) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.
updateUser(uid, özellikler) 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ı makaleyi inceleyin.
verifyIdToken(idToken, checkCanceld) (Kimlik Jetonu, iptal edildi) Firebase kimlik jetonunu (JWT) doğrular. Jeton geçerliyse söz konusu jetonun kodu çözülmüş hak talepleri yerine getirilir. Aksi takdirde söz reddedilir.checkRevoked doğru değerine ayarlanırsa önce 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. Yanıt 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 Doğrulama Kimlik Jetonlarını inceleyin.
verifySessionCookie(sessionCookie, checkCanceld) Bir Firebase oturum çerezini doğrular. Çerez talepleriyle birlikte bir Promise döndürür. Çerez doğrulanamazsa sözü reddeder.checkRevoked doğru değerine ayarlanırsa önce ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular: Yanıt evet ise auth/user-disabled hatası verilir. Yanıt 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 gerçekleştirilmez.Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Doğrulama'ya bakın.

BaseAuth.createCustomToken()

İstemci SDK'larının signInWithCustomToken() yöntemleriyle oturum açmak için kullanmak üzere istemci cihazına geri gönderilebilecek yeni bir Firebase özel jetonu (JWT) oluşturur. (Kiracıya duyarlı örnekler de kiracı kimliğini 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
kullanıcı kimliği dize Özel jetonun konusu olarak kullanılacak uid.
developerClaims nesne Özel jetonun yüküne dahil edilecek isteğe bağlı ek hak talepleri.

İadeler:

Söz<dize>

Sağlanan uid ve yük için özel jetonla yerine getirilen bir söz.

BaseAuth.createProviderConfig()

Yeni sağlayıcı yapılandırması oluşturulduğunda yeni oluşturulan AuthProviderConfig ile çözümlenen bir söz döndürür.

SAML ve OIDC sağlayıcı desteği için Google Cloud Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.

İmza:

createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;

Parametreler

Parametre Tür Açıklama
config AuthProviderConfig Oluşturulacak sağlayıcı yapılandırması.

İadeler:

Taahhüt<AuthProviderConfig>

Oluşturulan sağlayıcı yapılandırmasıyla çözümlenecek bir taahhüt.

BaseAuth.createSessionCookie()

Belirtilen seçeneklerle yeni bir Firebase oturum çerezi oluşturur. Oluşturulan JWT dizesi, özel bir çerez politikasıyla sunucu tarafı oturum çerezi olarak ayarlanabilir ve oturum yönetimi için kullanılabilir. Oturum çerezi JWT, sağlanan kimlik jetonuyla aynı yük taleplerine sahip olur.

Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Yönetme sayfasına bakın.

İmza:

createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;

Parametreler

Parametre Tür Açıklama
idToken dize Oturum çereziyle değiştirilebilecek Firebase Kimliği jetonu.
oturumÇerezSeçenekleri SessionCookieOptions Özel oturum süresini içeren oturum çerezi seçenekleri.

İadeler:

Söz<dize>

Oluşturulan oturum çereziyle başarıya ulaşma sözü.

BaseAuth.createUser()

Yeni bir kullanıcı oluşturur.

Kod örnekleri ve ayrıntılı belgeler için Kullanıcı oluşturma bölümüne bakın.

İmza:

createUser(properties: CreateRequest): Promise<UserRecord>;

Parametreler

Parametre Tür Açıklama
özellikler CreateRequest (İstek Oluştur) Oluşturulacak yeni kullanıcı kaydında ayarlanacak özellikler.

İadeler:

Söz<UserRecord>

Yeni oluşturulan kullanıcıya karşılık gelen kullanıcı verileriyle yerine getirilen bir söz.

BaseAuth.deleteProviderConfig()

İ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 Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.

İ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.

İadeler:

Taahhüt<void>

Tamamlandığında somut 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ı makaleyi inceleyin.

İmza:

deleteUser(uid: string): Promise<void>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimliği dize Silinecek kullanıcıya karşılık gelen uid.

İadeler:

Taahhüt<void>

Kullanıcı silindikten sonra yerine getirilen boş vaat.

BaseAuth.deleteUsers()

Belirtilen kullanıcı kimlikleri tarafından belirtilen kullanıcıları siler.

Mevcut olmayan bir kullanıcıyı silmek hata oluşturmaz (yani bu yöntem eş değersizdir). 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 döndürür.

Bu API'nin şu anda 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 eklemeniz gerekebilir.

İmza:

deleteUsers(uids: string[]): Promise<DeleteUsersResult>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimlikleri dize[] Silinecek kullanıcılara karşılık gelen uids.

İadeler:

Söz<DeleteUsersResult>

Toplam başarılı/başarısız silme sayısına ve başarısız silme işlemlerine karşılık gelen hata dizisine çözümlenen bir Söz.

Kullanıcının belirtilen e-posta adresinin sahibi olduğunu doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yöntemin bağımsız değişkeni 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ı.
actionCodeSettings ActionCodeSettings İşlem kodu ayarları. Belirtilirse durum/devam etme URL'si, e-posta doğrulama bağlantısında "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulaması açılış sayfası, yüklüyse uygulamaya geri dönme bağlantısını göstermek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde bir hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştirici, Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul ederse kullanılabilir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırıldıklarında dikkate alınır.

İadeler:

Söz<dize>

Oluşturulan bağlantıyla çözümlenen bir söz.

Ö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
    });

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 adresiyle 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.
actionCodeSettings ActionCodeSettings İşlem kodu ayarları. Belirtilirse durum/devam etme URL'si, şifre sıfırlama bağlantısında "continueUrl" parametresi olarak ayarlanır. Varsayılan şifre sıfırlama açılış sayfası, yüklüyse uygulamaya geri dönmesi için bir bağlantı göstermek üzere bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde bir hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştirici, Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul ederse kullanılabilir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırıldıklarında dikkate alınır.

İadeler:

Söz<dize>

Oluşturulan bağlantıyla çözümlenen bir söz.

Ö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
    });

Kullanıcının belirtilen e-posta adresinin sahibi olduğunu doğrulamak için bant dışı e-posta işlem bağlantısını oluşturur. Bu yöntemin bağımsız değişkeni 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ı.
actionCodeSettings ActionCodeSettings İşlem kodu ayarları. Belirtilirse durum/devam etme URL'si, e-posta doğrulama bağlantısında "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulaması açılış sayfası, yüklüyse uygulamaya geri dönme bağlantısını göstermek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine URL eklenmez. Sağlanan eyalet URL'si, geliştirici tarafından konsolda beyaz listeye eklenmiş bir alana ait olmalıdır. Aksi takdirde bir hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştirici, Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul ederse kullanılabilir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırıldıklarında dikkate alınır.

İadeler:

Söz<dize>

Oluşturulan bağlantıyla çözümlenen bir söz.

Ö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
    });

Kullanıcının belirtilen e-postanın sahipliğini doğrulamak için bant dışı e-posta işlem bağlantısı oluşturur. Bu yöntemin bağımsız değişkeni 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.
actionCodeSettings ActionCodeSettings İşlem kodu ayarları. Belirtilirse durum/devam etme URL'si, e-posta doğrulama bağlantısında "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulaması açılış sayfası, yüklüyse uygulamaya geri dönme bağlantısını göstermek için bunu kullanır. actionCodeSettings belirtilmezse işlem URL'sine URL eklenmez. Sağlanan durum URL'si, konsolda yetkilendirilmiş bir alana ait olmalıdır. Aksi takdirde bir hata verilir. Mobil uygulama yönlendirmeleri yalnızca geliştirici, Firebase Dynamic Links hizmet şartlarını yapılandırıp kabul ederse kullanılabilir. Android paket adı ve iOS paket kimliği, yalnızca aynı Firebase Auth projesinde yapılandırıldıklarında dikkate alınır.

İadeler:

Söz<dize>

Oluşturulan bağlantıyla çözümlenen bir söz.

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 söz 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 Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.

İ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.

İadeler:

Taahhüt<AuthProviderConfig>

Sağlanan kimliğe karşılık gelen yapılandırmayla çözümlenen bir taahhüt.

BaseAuth.getUser()

Belirli bir uid'a karşılık gelen kullanıcı verilerini alır.

Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakın.

İmza:

getUser(uid: string): Promise<UserRecord>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimliği dize Verilerinin getirileceği kullanıcıya karşılık gelen uid.

İadeler:

Söz<UserRecord>

Sağlanan uid'a karşılık gelen kullanıcı verileriyle yerine getirildi.

BaseAuth.getUserByEmail()

Belirli bir e-postaya karşılık gelen kullanıcıya ilişkin kullanıcı verilerini alır.

Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakın.

İmza:

getUserByEmail(email: string): Promise<UserRecord>;

Parametreler

Parametre Tür Açıklama
e-posta dize Verileri alınacak kullanıcıya karşılık gelen e-posta.

İadeler:

Söz<UserRecord>

Sağlanan e-postadaki kullanıcı verileriyle yerine getirilen bir taahhüt.

BaseAuth.getUserByPhoneNumber()

Belirli bir telefon numarasına karşılık gelen kullanıcıya ilişkin 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 bölümüne bakı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ı.

İadeler:

Söz<UserRecord>

Sağlanan telefon numarasıyla ilişkili kullanıcı verileriyle yerine getirilen bir taahhüt.

BaseAuth.getUserByProviderUid()

Belirli bir sağlayıcı kimliğine karşılık gelen kullanıcı için kullanıcı verilerini alır.

Kod örnekleri ve ayrıntılı belgeler için Kullanıcı verilerini alma bölümüne bakı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; örneğin, Google sağlayıcısı için "google.com".
kullanıcı kimliği dize Belirtilen sağlayıcının kullanıcı tanımlayıcısı.

İadeler:

Söz<UserRecord>

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.

Sıralama garantisi yoktur; ö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 döndürür.

İ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.

İadeler:

Söz<GetUsersResult>

İlgili kullanıcı kayıtlarına dair çözümlenen bir taahhüt.

İstisnalar

FirebaseAuthError Tanımlayıcılardan herhangi biri geçersizse veya 100'den fazla tanımlayıcı belirtildiyse.

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ılırken UserImportOptions belirtilmesi gerekir. Bu işlem, toplu içe aktarma işlemleri için optimize edilmiştir ve uid, email ve yinelemelere neden olabilecek diğer tanımlayıcı benzersizliği kontrollerini 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 bilgileri içerdiğinde gerekli olan kullanıcı içe aktarma seçenekleri.

İadeler:

Söz<UserImportResult>

İşlem, içe aktarma işleminin sonucuyla tamamlandığında çözümlenen bir söz. Burada başarılı içe aktarma işlemlerinin sayısı, başarısız içe aktarmaların sayısı ve bunlara karşılık gelen 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) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.

İmza:

listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;

Parametreler

Parametre Tür Açıklama
seçenekler AuthProviderConfigFilter Uygulanacak sağlayıcı yapılandırması filtresi.

İadeler:

Söz<ListProviderConfigResults>

Filtre gereksinimlerini karşılayan sağlayıcı yapılandırmalarının listesiyle çözümlenen bir söz.

BaseAuth.listUsers()

pageToken tarafından belirtilen ofsetten başlayarak maxResults boyutunda bir kullanıcı listesi (yalnızca tek grup) alır. Bu özellik, belirtilen projenin tüm kullanıcılarını toplu olarak almak için kullanılır.

Kod örnekleri ve ayrıntılı belgeler için Tüm kullanıcıları listeleme sayfasına bakı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, ofset olmadan başlayan kullanıcıları döndürür.

İadeler:

Vaat<ListUsersResult>

İndirilen mevcut kullanıcı grubu ve sonraki sayfa jetonuyla çözüme kavuşturulacak bir söz.

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. Bu çağrının yapıldığı sunucunun saatinin doğru ayarlanmış ve senkronize edilmiş olması önemlidir.

Bu işlem, belirli bir kullanıcının tüm oturumlarını iptal eder ve mevcut oturumlardaki yeni kimlik jetonlarının basılmasını devre dışı bırakır. Ancak mevcut kimlik jetonları, kullanım süreleri dolana kadar (bir saat) etkin kalabilir. Kimlik jetonlarının iptal edildiğini doğrulamak için BaseAuth.verifyIdToken() işlevini kullanın. Burada checkRevoked, true olarak ayarlanır.

İmza:

revokeRefreshTokens(uid: string): Promise<void>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimliği dize Yenileme jetonları iptal edilecek kullanıcıya karşılık gelen uid.

İadeler:

Taahhüt<void>

Kullanıcının yenileme jetonları iptal edildikten sonra yerine getirilen boş söz.

BaseAuth.setCustomUserClaims()

Sağlanan uid ile tanımlanan mevcut bir kullanıcıyla ilgili geliştirici hak taleplerini ayarlar. Bu ek 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 (jetonun süresinin dolmasından sonra veya jetonun yenilenmesi zorunlu kılındığında) ve kullanıcının bir sonraki oturum açışında tüm cihazlara yayılmalı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'de 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.

İmza:

setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimliği dize Düzenlenecek kullanıcının uid.
özelKullanıcıTalepleri nesne | null Geliştirici, ayarlamayı talep ediyor. null değer iletilirse mevcut özel hak talepleri silinir. 1.000 bayttan büyük bir özel talep yükü iletmek hataya neden olur. Özel hak talepleri, kimliği doğrulanmış her istekte iletilen kullanıcı kimlik jetonuna eklenir. Erişimle alakalı olmayan kullanıcı özellikleri için veritabanını veya diğer ayrı depolama sistemlerini kullanın.

İadeler:

Taahhüt<void>

İşlem başarıyla tamamlandığında çözümlenen bir vaat.

BaseAuth.updateProviderConfig()

Belirtilen sağlayıcı kimliğine karşılık gelen güncellenmiş AuthProviderConfig ile çözümlenen bir söz 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 Identity Platform (GCIP) gerekir. Fiyatlandırma ve özellikler dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerini inceleyin.

İ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.

İadeler:

Taahhüt<AuthProviderConfig>

Güncellenen sağlayıcı yapılandırmasıyla çözümlenecek bir taahhüt.

BaseAuth.updateUser()

Mevcut bir kullanıcıyı günceller.

Kod örnekleri ve ayrıntılı belgeler için Bir kullanıcıyı güncelleme bölümüne göz atın.

İmza:

updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;

Parametreler

Parametre Tür Açıklama
kullanıcı kimliği dize Güncellenecek kullanıcıya karşılık gelen uid.
özellikler Güncelleme İsteği Sağlanan kullanıcıyla ilgili güncellenecek özellikler.

İadeler:

Söz<UserRecord>

Güncellenen kullanıcı verileriyle yerine getirilen bir söz.

BaseAuth.verifyIdToken()

Firebase kimlik jetonunu (JWT) doğrular. Jeton geçerliyse söz konusu jetonun kodu çözülmüş hak talepleri yerine getirilebilir; aksi takdirde taahhüt reddedilir.

checkRevoked doğru değerine ayarlanırsa önce 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. Yanıt 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
idToken dize Doğrulanacak kimlik jetonu.
onay iptal edildi boolean Kimlik jetonunun iptal edilip edilmediği kontrol edilir. Bu, ilgili kullanıcının tokensValidAfterTime zamanını kontrol etmek için Firebase Auth arka ucuna ek bir istek yapılmasını gerektirir. Belirtilmediğinde bu ek kontrol uygulanmaz.

İadeler:

Vaat<DecodedIdToken>

Kimlik jetonu geçerliyse jetonun kodu çözülmüş hak talepleriyle yerine getirilen bir söz; aksi takdirde reddedilen söz.

BaseAuth.verifySessionCookie()

Bir Firebase oturum çerezini doğrular. Çerez talepleriyle birlikte bir Promise döndürür. Çerez doğrulanamadıysa sözü reddeder.

checkRevoked doğru değerine ayarlanırsa önce ilgili kullanıcının devre dışı bırakılıp bırakılmadığını doğrular: Evet ise auth/user-disabled hatası verilir. Yanıt 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 gerçekleştirilmez.

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
oturumÇerezi dize Doğrulanacak oturum çerezi.
onay iptal edildi boolean

İadeler:

Vaat<DecodedIdToken>

Oturum çerezi geçerliyse oturum çerezinin kodu çözülmüş talepleriyle yerine getirilen bir söz, aksi durumda reddedilen söz.