TenantAwareAuth class

Zgodny z najemcami interfejs Auth używany do zarządzania użytkownikami, konfigurowania dostawców SAML/OIDC, generowania linków e-mail do resetowania hasła, weryfikacji adresu e-mail itp. w przypadku określonych najemców.

Obsługa wielu najemców wymaga Google Cloud Identity Platform (GCIP). Więcej informacji o GCIP, w tym o cenach i funkcjach, znajdziesz w dokumentacji GCDS.

Każdy najemca ma własnych dostawców tożsamości, ustawienia i zestawy użytkowników. Za pomocą TenantAwareAuth można też zarządzać użytkownikami określonego najemcy i odpowiadającymi im konfiguracjami OIDC/SAML, weryfikować tokeny identyfikatorów użytkowników zalogowanych w określonym najemcy, a także generować linki do działań związanych z e-mailami dla użytkowników należących do najemcy.

Wystąpienia TenantAwareAuth określonej tenantId można utworzyć, wywołując funkcję TenantManager.authForTenant().

Podpis:

export declare class TenantAwareAuth extends BaseAuth 

Rozszerza: BaseAuth

Właściwości

Właściwość	Modyfikatory	Typ	Opis
tenantId,		ciąg znaków	Identyfikator najemcy odpowiadający tej instancji TenantAwareAuth. Wszystkie wywołania interfejsów API do zarządzania użytkownikami, interfejsów API do zarządzania dostawcą OIDC/SAML, interfejsów API do generowania linków do e-maili itp. będą stosowane tylko w zakresie tego najemcy.

Metody

Metoda	Modyfikatory	Opis
createSessionCookie(idToken, sessionCookieOptions)		Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT może być ustawiony jako plik cookie sesji po stronie serwera z niestandardową zasadą dotyczącą plików cookie i może być używany do zarządzania sesją. Token JWT pliku cookie sesji będzie miał ten sam ładunek ładunku co podany token identyfikatora.Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Zarządzanie plikami cookie sesji.
verifyIdToken(idToken, checkUnieważniony)		Sprawdza token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica jest realizowana za pomocą zdekodowanych deklaracji. w przeciwnym razie obietnica jest odrzucana.Jeśli zasada checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi tożsamości została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/id-token-revoked. Jeśli nie określono tego ustawienia, kontrola nie zostanie zastosowana.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Weryfikacja tokenów tożsamości.
verifySessionCookie(sessionCookie, checkUnsubscribe)		Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z żądaniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie.Jeśli zasada checkRevoked ma wartość Prawda, najpierw sprawdza, czy dany użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca plikowi cookie sesji została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/session-cookie-revoked. Jeśli nie określono tego ustawienia, sprawdzanie nie jest wykonywane.Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w sekcji Sprawdzanie plików cookie sesji.

Identyfikator TenantAwareAuth.tenantId

Identyfikator najemcy odpowiadający tej instancji TenantAwareAuth. Wszystkie wywołania interfejsów API do zarządzania użytkownikami, interfejsów API do zarządzania dostawcą OIDC/SAML, interfejsów API do generowania linków do e-maili itp. będą stosowane tylko w zakresie tego najemcy.

Podpis:

readonly tenantId: string;

TenantAwareAuth.createSessionCookie()

Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT może być ustawiony jako plik cookie sesji po stronie serwera z niestandardową zasadą dotyczącą plików cookie i może być używany do zarządzania sesją. Token JWT pliku cookie sesji będzie miał taki sam ładunek jak podany token identyfikatora.

Przykładowy kod i szczegółową dokumentację znajdziesz w artykule Zarządzanie plikami cookie sesji.

Podpis:

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

Parametry

Parametr	Typ	Opis
idToken	ciąg znaków	Token identyfikatora Firebase, który ma zostać zastąpiony przez plik cookie sesji.
sessionCookieOptions	SessionCookieOptions.	Opcje plików cookie sesji, które obejmują niestandardowy czas trwania sesji.

Zwroty:

Obietnica<ciąg>

Obietnica, która kończy się po zrealizowaniu za pomocą utworzonego pliku cookie sesji.

TenantAwareAuth.verifyIdToken()

Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest prawidłowy, obietnica jest realizowana za pomocą zdekodowanych deklaracji. w przeciwnym razie obietnica zostanie odrzucona.

Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi tożsamości została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/id-token-revoked. Jeśli nie określono tej opcji, kontrola nie zostanie zastosowana.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Weryfikowanie tokenów tożsamości.

Podpis:

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

Parametry

Parametr	Typ	Opis
idToken	ciąg znaków	Token identyfikatora do zweryfikowania.
sprawdzanieUnieważnione	wartość logiczna	Określa, czy sprawdzić, czy token identyfikatora został unieważniony. Wymaga to przesłania dodatkowego żądania do backendu Uwierzytelniania Firebase, aby sprawdzić czas tokensValidAfterTime dla odpowiedniego użytkownika. Jeśli jej nie określisz, dodatkowa kontrola nie będzie stosowana.

Zwroty:

Obietnica<DecodedIdToken>

obietnica wypełniona zdekodowanymi deklaracjami tokena, jeśli token identyfikatora jest prawidłowy; w przeciwnym razie odrzucono.

TenantAwareAuth.verifySessionCookie()

Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z żądaniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie.

Jeśli checkRevoked ma wartość Prawda, najpierw sprawdź, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, jest zgłaszany błąd auth/user-disabled. Jeśli nie, sprawdza, czy sesja odpowiadająca plikowi cookie sesji została unieważniona. Jeśli sesja odpowiedniego użytkownika została unieważniona, zgłaszany jest błąd auth/session-cookie-revoked. Jeśli nie określono tej opcji, kontrola nie zostanie przeprowadzona.

Przykładowe fragmenty kodu i szczegółową dokumentację znajdziesz w artykule Weryfikowanie plików cookie sesji

Podpis:

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

Parametry

Parametr	Typ	Opis
sessionCookie	ciąg znaków	Plik cookie sesji do weryfikacji.
sprawdzanieUnieważnione	wartość logiczna

Zwroty:

Obietnica<DecodedIdToken>

Obietnica zrealizowana z odkodowanymi deklaracjami z pliku cookie sesji, jeśli plik cookie sesji jest prawidłowy. w przeciwnym razie odrzucono.