TenantAwareAuth class

Interface Auth adaptée aux locataires utilisée pour gérer les utilisateurs, configurer les fournisseurs SAML/OIDC, générer des liens de messagerie pour la réinitialisation du mot de passe, la vérification des e-mails, etc. pour des locataires spécifiques.

La prise en charge de l'architecture mutualisée nécessite la plate-forme d'identité de Google Cloud (GCIP). Pour en savoir plus sur GCIP, y compris les tarifs et les fonctionnalités, consultez la documentation GCIP. .

Chaque locataire contient ses propres fournisseurs d'identité, paramètres et ensembles d'utilisateurs. Utilisation TenantAwareAuth , les utilisateurs d'un locataire spécifique et les configurations OIDC/SAML correspondantes peuvent également être gérés, les jetons d'identification des utilisateurs connectés à un locataire spécifique peuvent être vérifiés et des liens d'action par courrier électronique peuvent également être générés pour les utilisateurs appartenant au locataire.

Les instances TenantAwareAuth pour un tenantId spécifique peuvent être instanciées en appelant TenantManager.authForTenant() .

Signature:

export declare class TenantAwareAuth extends BaseAuth 

Extension : BaseAuth

Propriétés

Propriété	Modificateurs	Taper	Description
ID locataire		chaîne	L'identifiant du locataire correspondant à cette instance TenantAwareAuth . Tous les appels aux API de gestion des utilisateurs, aux API de gestion des fournisseurs OIDC/SAML, aux API de génération de liens de courrier électronique, etc. ne seront appliqués que dans le cadre de ce locataire.

Méthodes

Méthode	Modificateurs	Description
créerSessionCookie(idToken, sessionCookieOptions)		Crée un nouveau cookie de session Firebase avec les options spécifiées. La chaîne JWT créée peut être définie comme cookie de session côté serveur avec une politique de cookie personnalisée et être utilisée pour la gestion de session. Le cookie de session JWT aura les mêmes revendications de charge utile que le jeton d'identification fourni. Voir Gérer les cookies de session pour des exemples de code et une documentation détaillée.
verifyIdToken(idToken, checkRevoked)		Vérifie un jeton d'identification Firebase (JWT). Si le jeton est valide, la promesse est remplie avec les revendications décodées du jeton ; sinon, la promesse est rejetée. Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé. Si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au jeton d'identification a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/id-token-revoked est générée. S’il n’est pas spécifié, le contrôle n’est pas appliqué. Consultez Vérifier les jetons d’identification pour obtenir des exemples de code et une documentation détaillée.
verifySessionCookie(sessionCookie, checkRevoked)		Vérifie un cookie de session Firebase. Renvoie une promesse avec les revendications des cookies. Rejette la promesse si le cookie n'a pas pu être vérifié. Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé : si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au cookie de session a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/session-cookie-revoked est générée. Si cela n’est pas spécifié, le contrôle n’est pas effectué. Voir Vérifier les cookies de session pour des exemples de code et une documentation détaillée

TenantAwareAuth.tenantId

L'identifiant du locataire correspondant à cette instance TenantAwareAuth . Tous les appels aux API de gestion des utilisateurs, aux API de gestion des fournisseurs OIDC/SAML, aux API de génération de liens de courrier électronique, etc. ne seront appliqués que dans le cadre de ce locataire.

Signature:

readonly tenantId: string;

TenantAwareAuth.createSessionCookie()

Crée un nouveau cookie de session Firebase avec les options spécifiées. La chaîne JWT créée peut être définie comme cookie de session côté serveur avec une politique de cookie personnalisée et être utilisée pour la gestion de session. Le cookie de session JWT aura les mêmes revendications de charge utile que le jeton d'identification fourni.

Voir Gérer les cookies de session pour des exemples de code et une documentation détaillée.

Signature:

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

Paramètres

Paramètre	Taper	Description
jeton d'identification	chaîne	Le jeton d'identification Firebase à échanger contre un cookie de session.
sessionCookieOptions	Options de cookie de session	Les options de cookie de session qui incluent une durée de session personnalisée.

Retour:

Promesse<string>

Une promesse qui se résout en cas de succès avec le cookie de session créé.

TenantAwareAuth.verifyIdToken()

Vérifie un jeton d'identification Firebase (JWT). Si le jeton est valide, la promesse est remplie avec les revendications décodées du jeton ; sinon, la promesse est rejetée.

Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé. Si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au jeton d'identification a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/id-token-revoked est générée. S’il n’est pas spécifié, le contrôle n’est pas appliqué.

Consultez Vérifier les jetons d’identification pour obtenir des exemples de code et une documentation détaillée.

Signature:

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

Paramètres

Paramètre	Taper	Description
jeton d'identification	chaîne	Le jeton d’identification à vérifier.
checkRévoqué	booléen	S'il faut vérifier si le jeton d'identification a été révoqué. Cela nécessite une requête supplémentaire au backend Firebase Auth pour vérifier l'heure tokensValidAfterTime pour l'utilisateur correspondant. Lorsqu’elle n’est pas précisée, cette vérification supplémentaire n’est pas appliquée.

Retour:

Promesse< DecodedIdToken >

Une promesse remplie avec les revendications décodées du jeton si le jeton d'identification est valide ; sinon, une promesse rejetée.

TenantAwareAuth.verifySessionCookie()

Vérifie un cookie de session Firebase. Renvoie une promesse avec les revendications des cookies. Rejette la promesse si le cookie n'a pas pu être vérifié.

Si checkRevoked est défini sur true, vérifie d'abord si l'utilisateur correspondant est désactivé : si oui, une erreur auth/user-disabled est générée. Si non, vérifie si la session correspondant au cookie de session a été révoquée. Si la session de l'utilisateur correspondant a été invalidée, une erreur auth/session-cookie-revoked est générée. Si cela n’est pas spécifié, le contrôle n’est pas effectué.

Voir Vérifier les cookies de session pour des exemples de code et une documentation détaillée

Signature:

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

Paramètres

Paramètre	Taper	Description
sessionCookie	chaîne	Le cookie de session à vérifier.
checkRévoqué	booléen

Retour:

Promesse< DecodedIdToken >

Une promesse remplie avec les revendications décodées du cookie de session si le cookie de session est valide ; sinon, une promesse rejetée.