TenantAwareAuth class

Kullanıcıları yönetmek, SAML/OIDC sağlayıcılarını yapılandırmak, belirli kiracılar için parola sıfırlama, e-posta doğrulama vb. için e-posta bağlantıları oluşturmak için kullanılan Kiracı Bilgili Auth arayüzü.

Çoklu kiracılık 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. .

Her kiracı kendi kimlik sağlayıcılarını, ayarlarını ve kullanıcı kümelerini içerir. TenantAwareAuth kullanma sayesinde, belirli bir kiracıya ait kullanıcılar ve karşılık gelen OIDC/SAML yapılandırmaları da yönetilebilir, belirli bir kiracıda oturum açan kullanıcılara yönelik kimlik belirteçleri doğrulanabilir ve kiracıya ait kullanıcılar için e-posta eylem bağlantıları da oluşturulabilir.

Belirli bir tenantId için TenantAwareAuth örnekleri , TenantManager.authForTenant() çağrılarak başlatılabilir. .

İmza:

export declare class TenantAwareAuth extends BaseAuth 

Uzatır: BaseAuth

Özellikler

Yöntemler

TenantAwareAuth.tenantId

Bu TenantAwareAuth örneğine karşılık gelen kiracı tanımlayıcısı. Kullanıcı yönetimi API'lerine, OIDC/SAML sağlayıcı yönetimi API'lerine, e-posta bağlantısı oluşturma API'lerine vb. yapılan tüm çağrılar yalnızca bu kiracı kapsamında uygulanacaktır.

İmza:

readonly tenantId: string;

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

İadeler:

Söz<string>

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

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

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

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

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