Interfejs Auth obsługujący dzierżawcę, używany do zarządzania użytkownikami, konfigurowania dostawców SAML/OIDC, generowania łączy e-mail w celu resetowania hasła, weryfikacji adresu e-mail itp. dla określonych najemców.
Obsługa wielu dzierżaw wymaga platformy tożsamości Google Cloud (GCIP). Aby dowiedzieć się więcej o GCIP, w tym o cenach i funkcjach, zapoznaj się z dokumentacją GCIP .
Każdy dzierżawca zawiera własnych dostawców tożsamości, ustawienia i zestawy użytkowników. Korzystanie z TenantAwareAuth , można także zarządzać użytkownikami dla określonej dzierżawy i odpowiadającymi im konfiguracjami OIDC/SAML, weryfikować tokeny identyfikacyjne użytkowników zalogowanych w określonej dzierżawie, a dla użytkowników należących do dzierżawy można także generować łącza do działań e-mailowych.
Instancje TenantAwareAuth dla określonego tenantId można utworzyć, wywołując metodę TenantManager.authForTenant() .
Podpis:
export declare class TenantAwareAuth extends BaseAuth
Rozszerza: BaseAuth
Nieruchomości
| Nieruchomość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| identyfikator najemcy | strunowy | Identyfikator dzierżawy odpowiadający temu wystąpieniu TenantAwareAuth . Wszystkie wywołania interfejsów API zarządzania użytkownikami, interfejsów API zarządzania dostawcami OIDC/SAML, interfejsów API generowania łączy e-mail itp. będą stosowane wyłącznie w ramach tej dzierżawy. |
Metody
| metoda | Modyfikatory | Opis |
|---|---|---|
| utwórzSessionCookie(idToken, sessionCookieOptions) | Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT można ustawić jako plik cookie sesji po stronie serwera z niestandardowymi zasadami dotyczącymi plików cookie i używać go do zarządzania sesją. Sesyjny plik cookie JWT będzie zawierał te same oświadczenia dotyczące ładunku, co dostarczony token identyfikacyjny. Zobacz Zarządzanie plikami cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją. | |
| zweryfikowaćIdToken(idToken, checkRevoked) | Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest ważny, obietnica zostaje spełniona dzięki zdekodowanym żądaniom tokena; w przeciwnym razie obietnica zostanie odrzucona. Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi ID 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, kontrola nie jest stosowana. Zobacz Weryfikacja tokenów identyfikacyjnych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją. | |
| zweryfikujSessionCookie(sessionCookie, sprawdźUnieważnione) | Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z oświadczeniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie. Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony: Jeśli tak, zgłaszany jest 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, kontrola nie jest wykonywana. Zobacz Weryfikacja plików cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją |
TenantAwareAuth.tenantId
Identyfikator dzierżawy odpowiadający temu wystąpieniu TenantAwareAuth . Wszystkie wywołania interfejsów API zarządzania użytkownikami, interfejsów API zarządzania dostawcami OIDC/SAML, interfejsów API generowania łączy e-mail itp. będą stosowane wyłącznie w ramach tej dzierżawy.
Podpis:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Tworzy nowy plik cookie sesji Firebase z określonymi opcjami. Utworzony ciąg JWT można ustawić jako plik cookie sesji po stronie serwera z niestandardowymi zasadami dotyczącymi plików cookie i używać go do zarządzania sesją. Sesyjny plik cookie JWT będzie zawierał te same oświadczenia dotyczące ładunku, co dostarczony token identyfikacyjny.
Zobacz Zarządzanie plikami cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją.
Podpis:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| idToken | strunowy | Token identyfikatora Firebase do wymiany na plik cookie sesji. |
| Opcje plików cookie sesji | Opcje plików cookie sesji | Opcje plików cookie sesji, które obejmują niestandardowy czas trwania sesji. |
Zwroty:
Obietnica<string>
Obietnica, która gwarantuje sukces dzięki utworzonemu plikowi cookie sesji.
TenantAwareAuth.verifyIdToken()
Weryfikuje token identyfikatora Firebase (JWT). Jeśli token jest ważny, obietnica zostaje spełniona dzięki zdekodowanym żądaniom tokena; w przeciwnym razie obietnica zostanie odrzucona.
Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony. Jeśli tak, zgłaszany jest błąd auth/user-disabled . Jeśli nie, sprawdza, czy sesja odpowiadająca tokenowi ID 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, kontrola nie jest stosowana.
Zobacz Weryfikacja tokenów identyfikacyjnych , aby zapoznać się z przykładowymi kodami i szczegółową dokumentacją.
Podpis:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| idToken | strunowy | Token identyfikacyjny do sprawdzenia. |
| sprawdźUnieważnione | wartość logiczna | Określa, czy sprawdzać, czy token identyfikacyjny został unieważniony. Wymaga to dodatkowego żądania do zaplecza Firebase Auth w celu sprawdzenia czasu tokensValidAfterTime dla odpowiedniego użytkownika. Jeżeli nie określono inaczej, to dodatkowe sprawdzenie nie jest stosowane. |
Zwroty:
Obietnica < DecodedIdToken >
Obietnica spełniona dzięki zdekodowanym żądaniom tokena, jeśli token identyfikacyjny jest ważny; w przeciwnym razie odrzucona obietnica.
TenantAwareAuth.verifySessionCookie()
Weryfikuje plik cookie sesji Firebase. Zwraca obietnicę z oświadczeniami dotyczącymi plików cookie. Odrzuca obietnicę, jeśli nie można zweryfikować pliku cookie.
Jeśli checkRevoked jest ustawione na true, najpierw sprawdza, czy odpowiedni użytkownik jest wyłączony: Jeśli tak, zgłaszany jest 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, kontrola nie jest wykonywana.
Zobacz Weryfikacja plików cookie sesji , aby zapoznać się z przykładami kodu i szczegółową dokumentacją
Podpis:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| plik cookie sesji | strunowy | Plik cookie sesji do sprawdzenia. |
| sprawdźUnieważnione | wartość logiczna |
Zwroty:
Obietnica < DecodedIdToken >
Obietnica spełniona w przypadku zdekodowanych roszczeń sesyjnego pliku cookie, jeśli sesyjny plik cookie jest ważny; w przeciwnym razie odrzucona obietnica.