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 Tanım
createCustomToken(uid, geliştirici Talepleri) İstemci signInWithCustomToken() yöntemleriyle oturum açmak için kullanmak üzere istemci cihazına geri gönderilebilecek yeni bir Firebase özel belirteci (JWT) oluşturur. (Kiracının farkında olduğu bulut sunucuları aynı zamanda kiracı kimliğini de belirtecin içine yerleştirecektir.) Kod örnekleri ve ayrıntılı belgeler için Özel Belirteçler Oluşturma konusuna bakın.
createProviderConfig(yapılandırma) 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, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
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 belirteciyle aynı yük taleplerine sahip olacaktır. Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Yönetme konusuna bakın.
createUser(özellikler) Yeni bir kullanıcı oluşturur. Kod örnekleri ve ayrıntılı belgeler için Kullanıcı oluşturma konusuna bakın.
deleteProviderConfig(sağlayıcıId) Aktarılan 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ı atılır. SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
Kullanıcıyı sil(uid) Mevcut bir kullanıcıyı siler. Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcıyı silme .
Kullanıcıları sil(uidler) Verilen kullanıcı kimlikleri tarafından belirtilen kullanıcıları siler. Mevcut olmayan bir kullanıcının silinmesi bir hata oluşturmaz (yani bu yöntem önemsizdir.) Mevcut olmayan kullanıcıların başarıyla silindiği kabul edilir ve bu nedenle, DeleteUsersResult.successCount değerinde sayılır. Yalnızca maksimum 1000 tanımlayıcı sağlanabilir. 1000'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError oluşturur. Bu API şu anda sunucuda 1 QPS ile sınırlıdır. Bunu aşarsanız kota aşıldı hatası alabilirsiniz. Bu nedenle 1000'den fazla kullanıcıyı silmek istiyorsanız bu sınırı aşmamak için bir gecikme eklemeniz gerekebilir.
createdEmailVerificationLink(e-posta, actionCodeSettings) Kullanıcının belirtilen e-postanın sahibi olduğunu doğrulamak için bant dışı e-posta eylemi bağlantısını oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.
createdPasswordResetLink(e-posta, actionCodeSettings) Kullanıcının parolasını sıfırlamak için bant dışı e-posta eylem 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 mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya vb. aktarılacak ek durum bilgilerini tanımlar.
createdSignInWithEmailLink(e-posta, actionCodeSettings) Kullanıcının belirtilen e-postanın sahibi olduğunu doğrulamak için bant dışı e-posta eylemi bağlantısını oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.
createdVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) Kullanıcının belirtilen e-postaya sahip olduğunu doğrulamak için bant dışı bir e-posta eylem bağlantısı oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.
getProviderConfig(sağlayıcıKimliği) Sağlanan kimliğe göre Kimlik Doğrulama sağlayıcısı yapılandırmasını 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ı atılır. SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
getUser(uid) Belirli bir uid karşılık gelen kullanıcının kullanıcı verilerini alır. Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .
getUserByEmail(e-posta) Belirli bir e-postaya karşılık gelen kullanıcının kullanıcı verilerini alır. Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .
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 bkz . Kullanıcı verilerini alma .
getUserByProviderUid(sağlayıcıKimliği, kullanıcı kimliği) Belirli bir sağlayıcı kimliğine karşılık gelen kullanıcının kullanıcı verilerini alır. Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .
getUsers(tanımlayıcılar) Belirtilen tanımlayıcılara karşılık gelen kullanıcı verilerini alır. Sipariş garantisi yoktur; özellikle sonuç listesindeki n'inci girişin, giriş parametreleri listesindeki n'inci girişe karşılık geleceği garanti edilmez. Yalnızca maksimum 100 tanımlayıcı sağlanabilir. 100'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError oluşturur.
importUsers(kullanıcılar, seçenekler) Sağlanan kullanıcı listesini Firebase Auth'a aktarır. Tek seferde en fazla 1000 kullanıcının içe aktarılmasına izin verilir. Kullanıcıları parolalarla içe aktarırken UserImportOptions'ın belirtilmesi gerekir. Bu işlem, toplu içe aktarmalar için optimize edilmiştir ve uid , email ve çoğaltmalarla sonuçlanabilecek diğer tanımlayıcı benzersizliği üzerindeki kontrolleri göz ardı edecektir.
listProviderConfigs(seçenekler) 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, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
listUsers(maxResults, pageToken) pageToken tarafından belirtilen uzaklıktan başlayarak maxResults boyutuna sahip kullanıcıların listesini (yalnızca tek toplu iş) alır. Bu, belirli bir 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 konusuna bakın.
revokeRefreshTokens(uid) Mevcut bir kullanıcı için tüm yenileme belirteçlerini iptal eder. Bu API, kullanıcının UserRecord.tokensValidAfterTime değerini mevcut UTC'ye güncelleyecektir. Bunun çağrıldığı sunucunun saatinin doğru ayarlanmış ve senkronize edilmiş olması önemlidir. Bu, belirli bir kullanıcı için tüm oturumları iptal edecek ve mevcut oturumlar için yeni kimlik belirteçlerinin basılmasını devre dışı bırakacak olsa da, mevcut kimlik belirteçleri doğal süreleri dolana kadar (bir saat) etkin kalabilir. Kimlik belirteçlerinin iptal edildiğini doğrulamak için checkRevoked true olarak ayarlandığı BaseAuth.verifyIdToken() işlevini kullanın.
setCustomUserClaims(uid, özelUserClaims) Sağlanan uid tarafından tanımlanan mevcut bir kullanıcı üzerinde, genellikle kullanıcı rollerini ve erişim düzeylerini tanımlamak için kullanılan ek geliştirici taleplerini ayarlar. Bu talepler, kullanıcının zaten oturum açmış olduğu tüm cihazlara (belirteç süresinin dolmasından sonra veya belirteç yenilemeye zorlandığında) ve kullanıcının bir sonraki oturum açma işleminde geçerli olmalıdır. Ayrılmış bir OIDC talep adı kullanılıyorsa (sub, iat, iss, vb.) ), bir hata atılır. Kimliği doğrulanmış kullanıcının kimlik belirteci JWT'ye ayarlanırlar. Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı rollerini ve erişim düzeylerini tanımlama .
updateProviderConfig(providerId, güncellenenConfig) 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ı atılır. SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .
updateUser(uid, özellikler) Mevcut bir kullanıcıyı günceller. Kod örnekleri ve ayrıntılı belgeler için Kullanıcıyı güncelleme konusuna bakın.
doğrulamaIdToken(idToken, checkRevoked) Firebase ID jetonunu (JWT) doğrular. Token geçerliyse söz, tokenin kodu çözülmüş talepleriyle yerine getirilir; aksi takdirde söz reddedilir. checkRevoked true olarak ayarlanırsa öncelikle ilgili kullanıcının devre dışı olup olmadığı doğrulanır. Evetse, auth/user-disabled bir hata atılır. Hayır ise, kimlik belirtecine karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılındıysa, bir auth/id-token-revoked hatası oluşturulur. Belirtilmemişse kontrol uygulanmaz. Kod örnekleri ve ayrıntılı belgeler için Kimlik Belirteçlerini Doğrulama konusuna bakın.
doğrulamaSessionCookie(sessionCookie, checkRevoked) Firebase oturum çerezini doğrular. Çerez talepleriyle birlikte bir Promise döndürür. Çerez doğrulanamadığı takdirde sözü reddeder. checkRevoked true olarak ayarlanırsa, öncelikle ilgili kullanıcının devre dışı olup olmadığı doğrulanır: Evetse, bir auth/user-disabled hatası atılır. 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ındıysa, bir auth/session-cookie-revoked hatası oluşturulur. Belirtilmemişse kontrol yapılmaz. Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Doğrulama konusuna bakın

BaseAuth.createCustomToken()

İstemci signInWithCustomToken() yöntemleriyle oturum açmak için kullanmak üzere istemci cihazına geri gönderilebilecek yeni bir Firebase özel belirteci (JWT) oluşturur. (Kiracının farkında olduğu bulut sunucuları aynı zamanda kiracı kimliğini de belirtecin içine yerleştirecektir.)

Kod örnekleri ve ayrıntılı belgeler için Özel Belirteçler Oluşturma konusuna bakın.

İmza:

createCustomToken(uid: string, developerClaims?: object): Promise<string>;

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Özel belirtecin konusu olarak kullanılacak uid .
geliştiriciİddialar nesne Özel belirtecin yüküne dahil edilecek isteğe bağlı ek talepler.

İadeler:

Söz<string>

Sağlanan uid ve yük için özel bir belirteçle 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, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .

İmza:

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

Parametreler

Parametre Tip Tanım
yapılandırma AuthProviderYapılandırması Oluşturulacak sağlayıcı yapılandırması.

İadeler:

Promise< AuthProviderConfig >

Oluşturulan sağlayıcı yapılandırmasıyla çözülen bir söz.

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 belirteciyle aynı yük taleplerine sahip olacaktır.

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

İmza:

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

Parametreler

Parametre Tip Tanım
idToken sicim Oturum çerezi ile değiştirilecek Firebase ID jetonu.
oturumÇerezSeçenekleri OturumÇerezSeçenekleri Özel oturum süresini içeren oturum çerezi seçenekleri.

İadeler:

Söz<string>

Oluşturulan oturum çerezi ile başarıya ulaşan bir söz.

BaseAuth.createUser()

Yeni bir kullanıcı oluşturur.

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

İmza:

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

Parametreler

Parametre Tip Tanım
özellikler İstek Oluştur Oluşturulacak yeni kullanıcı kaydında ayarlanacak özellikler.

İadeler:

Söz< Kullanıcı Kaydı >

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

BaseAuth.deleteProviderConfig()

Aktarılan 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ı atılır.

SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .

İmza:

deleteProviderConfig(providerId: string): Promise<void>;

Parametreler

Parametre Tip Tanım
sağlayıcı kimliği sicim Silinecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği.

İadeler:

Söz<void>

Tamamlandığında çözülecek bir söz.

BaseAuth.deleteUser()

Mevcut bir kullanıcıyı siler.

Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcıyı silme .

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Silinecek kullanıcıya karşılık gelen kullanıcı uid .

İadeler:

Söz<void>

Kullanıcı silindikten sonra yerine getirilen boş bir söz.

BaseAuth.deleteUsers()

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

Mevcut olmayan bir kullanıcının silinmesi bir hata oluşturmaz (yani bu yöntem önemsizdir.) Mevcut olmayan kullanıcıların başarıyla silindiği kabul edilir ve bu nedenle, DeleteUsersResult.successCount değerinde sayılır.

Yalnızca maksimum 1000 tanımlayıcı sağlanabilir. 1000'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError oluşturur.

Bu API şu anda sunucuda 1 QPS ile sınırlıdır. Bunu aşarsanız kota aşıldı hatası alabilirsiniz. Bu nedenle 1000'den fazla kullanıcıyı silmek istiyorsanız bu sınırı aşmamak için bir gecikme eklemeniz gerekebilir.

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimlikleri sicim[] Silinecek kullanıcılara karşılık gelen kullanıcı uids .

İadeler:

Söz Ver< Kullanıcıları SilSonuç >

Başarılı/başarısız silme işlemlerinin toplam sayısını ve ayrıca başarısız silme işlemlerine karşılık gelen hata dizisini çözümleyen bir Söz.

Kullanıcının belirtilen e-postanın sahibi olduğunu doğrulamak için bant dışı e-posta eylemi bağlantısını oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.

İmza:

generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametreler

Parametre Tip Tanım
e-posta sicim Doğrulanacak e-posta hesabı.
eylemKoduAyarları Eylem Kodu Ayarları Eylem kodu ayarları. Belirtilmişse durum/devam URL'si, e-posta doğrulama bağlantısındaki "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulama açılış sayfası, yüklüyse uygulamaya geri dönmek için bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse eylem URL'sine hiçbir URL eklenmez. Sağlanan durum URL'si, geliştirici tarafından konsolda beyaz listeye eklenen bir alana ait olmalıdır. Aksi halde hata atılır. 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ışlarsa dikkate alınır.

İadeler:

Söz<string>

Oluşturulan bağlantıyla çözülen 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 parolasını sıfırlamak için bant dışı e-posta eylem 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 mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya vb. aktarılacak ek durum bilgilerini tanımlar.

İmza:

generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametreler

Parametre Tip Tanım
e-posta sicim Şifresi sıfırlanacak kullanıcının e-posta adresi.
eylemKoduAyarları Eylem Kodu Ayarları Eylem kodu ayarları. Belirtilmişse durum/devam 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önmek için bir bağlantı görüntülemek için bunu kullanacaktır. actionCodeSettings belirtilmezse eylem URL'sine hiçbir URL eklenmez. Sağlanan durum URL'si, geliştirici tarafından konsolda beyaz listeye eklenen bir alana ait olmalıdır. Aksi halde hata atılır. 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ışlarsa dikkate alınır.

İadeler:

Söz<string>

Oluşturulan bağlantıyla çözülen 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-postanın sahibi olduğunu doğrulamak için bant dışı e-posta eylemi bağlantısını oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.

İmza:

generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;

Parametreler

Parametre Tip Tanım
e-posta sicim Doğrulanacak e-posta hesabı.
eylemKoduAyarları Eylem Kodu Ayarları Eylem kodu ayarları. Belirtilmişse durum/devam URL'si, e-posta doğrulama bağlantısındaki "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulama açılış sayfası, yüklüyse uygulamaya geri dönmek için bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse eylem URL'sine hiçbir URL eklenmez. Sağlanan durum URL'si, geliştirici tarafından konsolda beyaz listeye eklenen bir alana ait olmalıdır. Aksi halde hata atılır. 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ışlarsa dikkate alınır.

İadeler:

Söz<string>

Oluşturulan bağlantıyla çözülen 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-postaya sahip olduğunu doğrulamak için bant dışı bir e-posta eylem bağlantısı oluşturur. Bu yönteme argüman olarak sunulan ActionCodeSettings nesnesi, bağlantının bir mobil uygulama mı yoksa tarayıcı tarafından mı yönetileceğini ve derin bağlantıya aktarılacak ek durum bilgilerini vb. tanımlar.

İmza:

generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;

Parametreler

Parametre Tip Tanım
e-posta sicim Geçerli e-posta hesabı.
Yeni E-posta sicim Hesabın güncelleneceği e-posta adresi.
eylemKoduAyarları Eylem Kodu Ayarları Eylem kodu ayarları. Belirtilmişse durum/devam URL'si, e-posta doğrulama bağlantısındaki "continueUrl" parametresi olarak ayarlanır. Varsayılan e-posta doğrulama açılış sayfası, yüklüyse uygulamaya geri dönmek için bir bağlantı görüntülemek için bunu kullanır. actionCodeSettings belirtilmezse eylem URL'sine hiçbir URL eklenmez. Sağlanan durum URL'si, konsolda yetkilendirilmiş bir etki alanına ait olmalıdır, aksi takdirde bir hata atılacaktır. 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ışlarsa dikkate alınır.

İadeler:

Söz<string>

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

BaseAuth.getProviderConfig()

Sağlanan kimliğe göre Kimlik Doğrulama sağlayıcısı yapılandırmasını 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ı atılır.

SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .

İmza:

getProviderConfig(providerId: string): Promise<AuthProviderConfig>;

Parametreler

Parametre Tip Tanım
sağlayıcı kimliği sicim Döndürülecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği.

İadeler:

Promise< AuthProviderConfig >

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

BaseAuth.getUser()

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

Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Verileri alınacak kullanıcıya karşılık gelen kullanıcı uid .

İadeler:

Söz< Kullanıcı Kaydı >

Sağlanan kullanıcı uid karşılık gelen kullanıcı verileriyle yerine getirilen bir söz .

BaseAuth.getUserByEmail()

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

Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .

İmza:

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

Parametreler

Parametre Tip Tanım
e-posta sicim Verileri alınacak kullanıcıya karşılık gelen e-posta.

İadeler:

Söz< Kullanıcı Kaydı >

Sağlanan e-postaya karşılık gelen kullanıcı verileriyle yerine getirilen bir söz.

BaseAuth.getUserByPhoneNumber()

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 bkz . Kullanıcı verilerini alma .

İmza:

getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;

Parametreler

Parametre Tip Tanım
telefon numarası sicim Verileri alınacak kullanıcıya karşılık gelen telefon numarası.

İadeler:

Söz< Kullanıcı Kaydı >

Sağlanan telefon numarasına karşılık gelen kullanıcı verileriyle yerine getirilen bir söz.

BaseAuth.getUserByProviderUid()

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

Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı verilerini alma .

İmza:

getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;

Parametreler

Parametre Tip Tanım
sağlayıcı kimliği sicim Sağlayıcı kimliği (örneğin, Google sağlayıcısının "google.com").
kullanıcı kimliği sicim Belirtilen sağlayıcının kullanıcı tanımlayıcısı.

İadeler:

Söz< Kullanıcı Kaydı >

Verilen sağlayıcı kimliğine karşılık gelen kullanıcı verileriyle yerine getirilen bir söz.

BaseAuth.getUsers()

Belirtilen tanımlayıcılara karşılık gelen kullanıcı verilerini alır.

Sipariş garantisi yoktur; özellikle sonuç listesindeki n'inci girişin, giriş parametreleri listesindeki n'inci girişe karşılık geleceği garanti edilmez.

Yalnızca maksimum 100 tanımlayıcı sağlanabilir. 100'den fazla tanımlayıcı sağlanırsa bu yöntem bir FirebaseAuthError oluşturur.

İmza:

getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;

Parametreler

Parametre Tip Tanım
tanımlayıcılar Kullanıcı Tanımlayıcı [] 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 çözümlenen bir söz.

İ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 1000 kullanıcının içe aktarılmasına izin verilir. Kullanıcıları parolalarla içe aktarırken UserImportOptions'ın belirtilmesi gerekir. Bu işlem toplu içe aktarma için optimize edilmiştir ve uid kontrollerini göz ardı edecektir , email ve kopyalara yol açabilecek diğer tanımlayıcı benzersizliği.

İmza:

importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;

Parametreler

Parametre Tip Tanım
kullanıcılar Kullanıcı İçe Aktarma Kaydı [] Firebase Auth'a aktarılacak kullanıcı kayıtlarının listesi.
seçenekler Kullanıcı İçe Aktarma Seçenekleri Sağlanan kullanıcılar parola kimlik bilgilerini içerdiğinde gerekli olan kullanıcı içe aktarma seçenekleri.

İadeler:

Promise< UserImportResult >

İşlem, içe aktarmanın sonucuyla tamamlandığında çözülen bir söz. Buna başarılı içe aktarmaların sayısı, başarısız içe aktarmaların sayısı ve bunlara karşılık gelen hatalar dahildir.

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, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .

İmza:

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

Parametreler

Parametre Tip Tanım
seçenekler AuthProviderConfigFiltre Uygulanacak sağlayıcı yapılandırma filtresi.

İadeler:

Promise< 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 uzaklıktan başlayarak maxResults boyutuna sahip kullanıcıların bir listesini (yalnızca tek toplu) alır . Bu, belirli bir 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 konusuna bakın.

İmza:

listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;

Parametreler

Parametre Tip Tanım
maxSonuçlar sayı Sayfa boyutu, tanımlanmamışsa 1000. Bu aynı zamanda izin verilen maksimum sınırdır.
sayfaJetonu sicim Sonraki sayfa jetonu. Belirtilmemişse, herhangi bir konum olmadan başlayan kullanıcıları döndürür.

İadeler:

Söz< ListeKullanıcıSonucu >

Mevcut indirilen kullanıcı grubu ve bir sonraki sayfa belirteci ile çözülen bir söz.

BaseAuth.revokeRefreshTokens()

Mevcut bir kullanıcı için tüm yenileme belirteçlerini iptal eder.

Bu API, kullanıcının UserRecord.tokensValidAfterTime değerini mevcut UTC'ye güncelleyecektir. Bunun çağrıldığı sunucunun saatinin doğru ayarlanmış ve senkronize edilmiş olması önemlidir.

Bu, belirli bir kullanıcı için tüm oturumları iptal edecek ve mevcut oturumlar için yeni kimlik belirteçlerinin basılmasını devre dışı bırakacak olsa da, mevcut kimlik belirteçleri doğal süreleri dolana kadar (bir saat) etkin kalabilir. Kimlik belirteçlerinin iptal edildiğini doğrulamak için checkRevoked true olarak ayarlandığı BaseAuth.verifyIdToken() işlevini kullanın.

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Yenileme belirteçleri iptal edilecek kullanıcıya karşılık gelen kullanıcı uid .

İadeler:

Söz<void>

Kullanıcının yenileme belirteçleri iptal edildikten sonra yerine getirilen boş bir söz.

BaseAuth.setCustomUserClaims()

Sağlanan uid tanımlanan mevcut bir kullanıcıyla ilgili ek geliştirici talepleri ayarlar , genellikle kullanıcı rollerini ve erişim düzeylerini tanımlamak için kullanılır. Bu talepler, kullanıcının zaten oturum açmış olduğu tüm cihazlara (belirteç süresinin dolmasından sonra veya belirteç yenilemeye zorlandığında) ve kullanıcının bir sonraki oturum açtığında geçerli olmalıdır. Ayrılmış bir OIDC talep adı kullanılıyorsa (sub, iat, iss, vb.) ), bir hata atılır. Kimliği doğrulanmış kullanıcının kimlik belirteci JWT'ye ayarlanırlar.

Kod örnekleri ve ayrıntılı belgeler için bkz . Kullanıcı rollerini ve erişim düzeylerini tanımlama .

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Düzenlenecek kullanıcının kullanıcı uid .
özelKullanıcı Talepleri nesne | hükümsüz Geliştirici ayarlamayı iddia ediyor. Boş değer iletilirse mevcut özel talepler silinir. 1000 bayttan büyük bir özel talep yükünün iletilmesi hataya neden olur. Kimliği doğrulanmış her istekte iletilen kullanıcının kimlik belirtecine özel talepler eklenir. Profilin erişimle ilgili olmayan kullanıcı özellikleri için veritabanını veya diğer ayrı depolama sistemlerini kullanın.

İadeler:

Söz<void>

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

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ı atılır.

SAML ve OIDC sağlayıcı desteği, Google Cloud'un Kimlik Platformunu (GCIP) gerektirir. Fiyatlandırma ve özellikler de dahil olmak üzere GCIP hakkında daha fazla bilgi edinmek için GCIP belgelerine bakın. .

İmza:

updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;

Parametreler

Parametre Tip Tanım
sağlayıcı kimliği sicim Güncellenecek sağlayıcı yapılandırmasına karşılık gelen sağlayıcı kimliği.
güncellenmişYapılandırma AuthProviderRequest'i güncelle Güncellenen yapılandırma.

İadeler:

Promise< AuthProviderConfig >

Güncellenen sağlayıcı yapılandırmasıyla çözülen bir söz.

BaseAuth.updateUser()

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

Kod örnekleri ve ayrıntılı belgeler için Kullanıcıyı güncelleme konusuna bakın.

İmza:

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

Parametreler

Parametre Tip Tanım
kullanıcı kimliği sicim Güncellenecek kullanıcıya karşılık gelen kullanıcı uid .
özellikler Güncelleme Talebi Sağlanan kullanıcıda güncellenecek özellikler.

İadeler:

Söz< Kullanıcı Kaydı >

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

BaseAuth.verifyIdToken()

Firebase ID jetonunu (JWT) doğrular. Token geçerliyse söz, tokenin kodu çözülmüş talepleriyle yerine getirilir; aksi takdirde söz reddedilir.

checkRevoked true olarak ayarlanırsa öncelikle ilgili kullanıcının devre dışı olup olmadığı doğrulanır. Evetse, auth/user-disabled bir hata atılır. Hayır ise, kimlik belirtecine karşılık gelen oturumun iptal edilip edilmediğini doğrular. İlgili kullanıcının oturumu geçersiz kılındıysa, bir auth/id-token-revoked hatası oluşturulur. Belirtilmemişse kontrol uygulanmaz.

Kod örnekleri ve ayrıntılı belgeler için Kimlik Belirteçlerini Doğrulama konusuna bakın.

İmza:

verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parametreler

Parametre Tip Tanım
idToken sicim Doğrulanacak kimlik belirteci.
checkİptal edildi boolean Kimlik belirtecinin iptal edilip edilmediğinin kontrol edilip edilmeyeceği. Bu, ilgili kullanıcının tokensValidAfterTime süresini kontrol etmek için Firebase Auth arka ucuna ekstra bir istek yapılmasını gerektirir. Belirtilmediği takdirde bu ek kontrol uygulanmaz.

İadeler:

Söz< DecodedIdToken >

Kimlik belirtecinin geçerli olması durumunda, belirtecin kodu çözülmüş talepleriyle yerine getirilen bir söz; aksi takdirde reddedilen bir söz.

BaseAuth.verifySessionCookie()

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

checkRevoked true olarak ayarlanırsa, öncelikle ilgili kullanıcının devre dışı olup olmadığı doğrulanır: Evetse, bir auth/user-disabled hatası atılır. 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ındıysa, bir auth/session-cookie-revoked hatası oluşturulur. Belirtilmemişse kontrol yapılmaz.

Kod örnekleri ve ayrıntılı belgeler için Oturum Çerezlerini Doğrulama konusuna bakın

İmza:

verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;

Parametreler

Parametre Tip Tanım
oturumÇerez sicim Doğrulanacak oturum çerezi.
checkİptal edildi boolean

İadeler:

Söz< DecodedIdToken >

Oturum çerezinin geçerli olması durumunda, oturum çerezinin kodu çözülmüş talepleriyle yerine getirilen bir söz; aksi takdirde reddedilen bir söz.