BaseAuth class

Auth ve TenantAwareAuth API'leri için ortak üst arayüz.

İmza:

export declare abstract class BaseAuth 

Yöntemler

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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

Ş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

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