TenantAwareAuth class

Mandantenfähige Auth , die zum Verwalten von Benutzern, zum Konfigurieren von SAML/OIDC-Anbietern, zum Generieren von E-Mail-Links zum Zurücksetzen von Passwörtern, zur E-Mail-Verifizierung usw. für bestimmte Mandanten verwendet wird.

Für die Mandantenfähigkeitsunterstützung ist die Identity Platform (GCIP) von Google Cloud erforderlich. Weitere Informationen zu GCIP, einschließlich Preisen und Funktionen, finden Sie in der GCIP-Dokumentation .

Jeder Mandant enthält seine eigenen Identitätsanbieter, Einstellungen und Benutzergruppen. Verwenden von TenantAwareAuth Außerdem können Benutzer für einen bestimmten Mandanten und entsprechende OIDC/SAML-Konfigurationen verwaltet werden, ID-Tokens für Benutzer, die bei einem bestimmten Mandanten angemeldet sind, überprüft werden und es können auch E-Mail-Aktionslinks für Benutzer generiert werden, die zum Mandanten gehören.

TenantAwareAuth Instanzen für eine bestimmte tenantId können durch Aufrufen von TenantManager.authForTenant() instanziiert werden. .

Unterschrift:

export declare class TenantAwareAuth extends BaseAuth

Erweitert: BaseAuth

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
Mieter-ID Zeichenfolge Der Mandantenbezeichner, der dieser TenantAwareAuth Instanz entspricht. Alle Aufrufe der Benutzerverwaltungs-APIs, OIDC/SAML-Anbieterverwaltungs-APIs, E-Mail-Link-Generierungs-APIs usw. werden nur im Rahmen dieses Mandanten angewendet.

Methoden

Methode Modifikatoren Beschreibung
createSessionCookie(idToken, sessionCookieOptions) Erstellt ein neues Firebase-Sitzungscookie mit den angegebenen Optionen. Der erstellte JWT-String kann als serverseitiges Sitzungscookie mit einer benutzerdefinierten Cookie-Richtlinie festgelegt und für die Sitzungsverwaltung verwendet werden. Das Sitzungscookie-JWT hat die gleichen Nutzlastansprüche wie das bereitgestellte ID-Token. Codebeispiele und eine ausführliche Dokumentation finden Sie unter Sitzungscookies verwalten .
verifyIdToken(idToken, checkRevoked) Verifiziert ein Firebase-ID-Token (JWT). Wenn der Token gültig ist, wird das Versprechen mit den entschlüsselten Ansprüchen des Tokens erfüllt; andernfalls wird das Versprechen abgelehnt. Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist. Wenn ja, wird ein auth/user-disabled ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem ID-Token entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/id-token-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht angewendet. Codebeispiele und ausführliche Dokumentation finden Sie unter „ID-Tokens überprüfen“ .
verifySessionCookie(sessionCookie, checkRevoked) Überprüft ein Firebase-Sitzungscookie. Gibt ein Versprechen mit den Cookie-Ansprüchen zurück. Lehnt das Versprechen ab, wenn das Cookie nicht überprüft werden konnte. Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist: Wenn ja, wird ein auth/user-disabled Fehler ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem Sitzungscookie entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/session-cookie-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht durchgeführt. Codebeispiele und eine ausführliche Dokumentation finden Sie unter „Sitzungscookies überprüfen“.

TenantAwareAuth.tenantId

Der Mandantenbezeichner, der dieser TenantAwareAuth Instanz entspricht. Alle Aufrufe der Benutzerverwaltungs-APIs, OIDC/SAML-Anbieterverwaltungs-APIs, E-Mail-Link-Generierungs-APIs usw. werden nur im Rahmen dieses Mandanten angewendet.

Unterschrift:

readonly tenantId: string;

TenantAwareAuth.createSessionCookie()

Erstellt ein neues Firebase-Sitzungscookie mit den angegebenen Optionen. Der erstellte JWT-String kann als serverseitiges Sitzungscookie mit einer benutzerdefinierten Cookie-Richtlinie festgelegt und für die Sitzungsverwaltung verwendet werden. Das Sitzungscookie-JWT hat die gleichen Nutzlastansprüche wie das bereitgestellte ID-Token.

Codebeispiele und eine ausführliche Dokumentation finden Sie unter Sitzungscookies verwalten .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
idToken Zeichenfolge Das Firebase-ID-Token, das gegen ein Sitzungscookie ausgetauscht werden soll.
sessionCookieOptions SessionCookieOptions Die Sitzungs-Cookie-Optionen, einschließlich der benutzerdefinierten Sitzungsdauer.

Kehrt zurück:

Versprechen<string>

Ein Versprechen, das bei Erfolg mit dem erstellten Sitzungscookie aufgelöst wird.

TenantAwareAuth.verifyIdToken()

Verifiziert ein Firebase-ID-Token (JWT). Wenn der Token gültig ist, wird das Versprechen mit den entschlüsselten Ansprüchen des Tokens erfüllt; andernfalls wird das Versprechen abgelehnt.

Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist. Wenn ja, wird ein auth/user-disabled ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem ID-Token entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/id-token-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht angewendet.

Codebeispiele und ausführliche Dokumentation finden Sie unter „ID-Tokens überprüfen“ .

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
idToken Zeichenfolge Das zu überprüfende ID-Token.
checkRevoked Boolescher Wert Ob überprüft werden soll, ob das ID-Token widerrufen wurde. Dies erfordert eine zusätzliche Anfrage an das Firebase Auth-Backend, um die tokensValidAfterTime Zeit für den entsprechenden Benutzer zu überprüfen. Wenn nicht angegeben, wird diese zusätzliche Prüfung nicht angewendet.

Kehrt zurück:

Versprechen< DecodedIdToken >

Ein Versprechen, das mit den entschlüsselten Ansprüchen des Tokens erfüllt wird, wenn das ID-Token gültig ist; andernfalls ein abgelehntes Versprechen.

TenantAwareAuth.verifySessionCookie()

Überprüft ein Firebase-Sitzungscookie. Gibt ein Versprechen mit den Cookie-Ansprüchen zurück. Lehnt das Versprechen ab, wenn das Cookie nicht überprüft werden konnte.

Wenn checkRevoked auf true gesetzt ist, wird zunächst überprüft, ob der entsprechende Benutzer deaktiviert ist: Wenn ja, wird ein auth/user-disabled Fehler ausgegeben. Wenn nein, wird überprüft, ob die Sitzung, die dem Sitzungscookie entspricht, widerrufen wurde. Wenn die Sitzung des entsprechenden Benutzers ungültig gemacht wurde, wird ein auth/session-cookie-revoked Fehler ausgegeben. Wenn nicht angegeben, wird die Prüfung nicht durchgeführt.

Codebeispiele und eine ausführliche Dokumentation finden Sie unter „Sitzungscookies überprüfen“.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
sessionCookie Zeichenfolge Das zu überprüfende Sitzungscookie.
checkRevoked Boolescher Wert

Kehrt zurück:

Versprechen< DecodedIdToken >

Ein Versprechen, das mit den entschlüsselten Ansprüchen des Sitzungscookies erfüllt wird, wenn das Sitzungscookie gültig ist; andernfalls ein abgelehntes Versprechen.