Interfaz de autenticación con reconocimiento de inquilinos utilizada para administrar usuarios, configurar proveedores de SAML/ Auth , generar enlaces de correo electrónico para restablecer contraseñas, verificar correos electrónicos, etc. para inquilinos específicos.
La compatibilidad con varios inquilinos requiere la plataforma de identidad de Google Cloud (GCIP). Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulte la documentación de GCIP .
Cada arrendatario contiene sus propios proveedores de identidad, configuraciones y conjuntos de usuarios. Uso TenantAwareAuth , también se pueden administrar los usuarios para un arrendatario específico y las configuraciones de OIDC/SAML correspondientes, se pueden verificar los tokens de ID para los usuarios que iniciaron sesión en un arrendatario específico y también se pueden generar enlaces de acción de correo electrónico para los usuarios que pertenecen al arrendatario.
Las instancias de TenantAwareAuth para un identificador de tenantId específico se pueden crear llamando a TenantManager.authForTenant() .
Firma:
export declare class TenantAwareAuth extends BaseAuth
Extiende: BaseAuth
Propiedades
| Propiedad | Modificadores | Escribe | Descripción |
|---|---|---|---|
| inquilinoId | cuerda | El identificador de arrendatario correspondiente a esta instancia de TenantAwareAuth . Todas las llamadas a las API de administración de usuarios, las API de administración de proveedores de OIDC/SAML, las API de generación de vínculos de correo electrónico, etc. solo se aplicarán dentro del alcance de este arrendatario. |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena JWT creada se puede configurar como una cookie de sesión del lado del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado. Consulte Administrar cookies de sesión para ver ejemplos de código y documentación detallada. | |
| verificarIdToken(idToken, verificarRevocado) | Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con los reclamos decodificados del token; de lo contrario, la promesa es rechazada. Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se arroja un error auth/user-disabled . Si no, verifica si la sesión correspondiente al token de ID fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error auth/id-token-revoked . Si no se especifica, no se aplica la comprobación. Consulte Verificar tokens de identificación para ver ejemplos de códigos y documentación detallada. | |
| verificarSessionCookie(sessionCookie, checkRevoked) | Verifica una cookie de sesión de Firebase. Devuelve una Promesa con los reclamos de cookies. Rechaza la promesa si no se pudo verificar la cookie. Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado: en caso afirmativo, se genera un error auth/user-disabled . Si no, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error de auth/session-cookie-revoked . Si no se especifica, no se realiza la comprobación. Consulte Verificar cookies de sesión para ver ejemplos de código y documentación detallada. |
TenantAwareAuth.tenantId
El identificador de arrendatario correspondiente a esta instancia de TenantAwareAuth . Todas las llamadas a las API de administración de usuarios, las API de administración de proveedores de OIDC/SAML, las API de generación de vínculos de correo electrónico, etc. solo se aplicarán dentro del alcance de este arrendatario.
Firma:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena JWT creada se puede configurar como una cookie de sesión del lado del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. La cookie de sesión JWT tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.
Consulte Administrar cookies de sesión para ver ejemplos de código y documentación detallada.
Firma:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parámetros
| Parámetro | Escribe | Descripción |
|---|---|---|
| idtoken | cuerda | El token de ID de Firebase para intercambiar por una cookie de sesión. |
| sessionCookieOptions | SessionCookieOptions | Las opciones de cookies de la sesión, que incluyen la duración de la sesión personalizada. |
Devoluciones:
Promesa <cadena>
Una promesa que se resuelve en caso de éxito con la cookie de sesión creada.
TenantAwareAuth.verifyIdToken()
Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con los reclamos decodificados del token; de lo contrario, la promesa es rechazada.
Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado. En caso afirmativo, se arroja un error auth/user-disabled . Si no, verifica si la sesión correspondiente al token de ID fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error auth/id-token-revoked . Si no se especifica, no se aplica la comprobación.
Consulte Verificar tokens de identificación para ver ejemplos de códigos y documentación detallada.
Firma:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Escribe | Descripción |
|---|---|---|
| idtoken | cuerda | El token de ID para verificar. |
| verificarRevocado | booleano | Si verificar si el token de ID fue revocado. Esto requiere una solicitud adicional al backend de Firebase Auth para verificar el tiempo de tokensValidAfterTime para el usuario correspondiente. Cuando no se especifica, esta verificación adicional no se aplica. |
Devoluciones:
Promesa< DecodedIdToken >
Una promesa cumplida con las reclamaciones decodificadas del token si el token de ID es válido; de lo contrario, una promesa rechazada.
TenantAwareAuth.verifySessionCookie()
Verifica una cookie de sesión de Firebase. Devuelve una Promesa con los reclamos de cookies. Rechaza la promesa si no se pudo verificar la cookie.
Si checkRevoked se establece en verdadero, primero verifica si el usuario correspondiente está deshabilitado: en caso afirmativo, se genera un error auth/user-disabled . Si no, verifica si la sesión correspondiente a la cookie de sesión fue revocada. Si se invalidó la sesión del usuario correspondiente, se genera un error de auth/session-cookie-revoked . Si no se especifica, no se realiza la comprobación.
Consulte Verificar cookies de sesión para ver ejemplos de código y documentación detallada.
Firma:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Escribe | Descripción |
|---|---|---|
| cookie de sesión | cuerda | La cookie de sesión para verificar. |
| verificarRevocado | booleano |
Devoluciones:
Promesa< DecodedIdToken >
Una promesa cumplida con las reclamaciones decodificadas de la cookie de sesión si la cookie de sesión es válida; de lo contrario, una promesa rechazada.