Interfaz Auth adaptada al usuario que se usa para administrar usuarios, configurar proveedores de SAML/OIDC, generar vínculos de correo electrónico para el restablecimiento de contraseñas, la verificación por correo electrónico, etc., de usuarios específicos.
La compatibilidad con la función multiusuario requiere Identity Platform (GCIP) de Google Cloud. Para obtener más información sobre GCIP, incluidos los precios y las funciones, consulta la documentación de GCIP.
Cada instancia contiene sus propios proveedores de identidad, configuración y grupos de usuarios. Con TenantAwareAuth, también se pueden administrar los usuarios de un usuario específico y los parámetros de configuración de OIDC/SAML correspondientes, se pueden verificar tokens de ID de usuarios que accedieron a un usuario específico y también se pueden generar vínculos de acciones de correo electrónico para los usuarios que pertenecen al usuario.
Se pueden crear instancias de TenantAwareAuth para un tenantId específico llamando a TenantManager.authForTenant().
Firma:
export declare class TenantAwareAuth extends BaseAuth
Extiende: BaseAuth
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| IDdeusuario | string | El identificador de usuario correspondiente a esta instancia de TenantAwareAuth. Todas las llamadas a las APIs de administración de usuarios, las APIs de administración de proveedores de OIDC/SAML, las APIs de generación de vínculos de correo electrónico, etc., solo se aplicarán dentro del alcance de este usuario. |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena de JWT creada se puede establecer como una cookie de sesión del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. El JWT de la cookie de sesión tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.Consulta Cómo administrar cookies de sesión para ver muestras de código y documentación detallada. | |
| verifyIdToken(idToken, checkRestrictedd) | Verifica un token de ID de Firebase (JWT). Si el token es válido, la promesa se cumple con las reclamaciones decodificadas del token. De lo contrario, se rechaza la promesa.Si se configura checkRevoked como true, primero verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente al token de ID. Si se invalida la sesión del usuario correspondiente, se genera un error auth/id-token-revoked. Si no se especifica, no se aplica la verificación.Consulta Verificar tokens de ID para ver muestras de código y documentación detallada. |
|
| verifySessionCookie(sessionCookie, checkRestrictedd) | Verifica una cookie de sesión de Firebase. Devuelve una promesa con las reclamaciones de cookies. Rechaza la promesa si no se pudo verificar la cookie.Si se configura checkRevoked como true, primero se verifica si el usuario correspondiente está inhabilitado. De ser así, se mostrará un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente a la cookie de sesión. Si se invalida la sesión del usuario correspondiente, se genera un error auth/session-cookie-revoked. Si no se especifica, no se realiza la verificación.Consulta Verificar cookies de sesión para ver muestras de código y documentación detallada. |
TenantAwareAuth.nombredelusuario
El identificador de usuario correspondiente a esta instancia de TenantAwareAuth. Todas las llamadas a las APIs de administración de usuarios, las APIs de administración de proveedores de OIDC/SAML, las APIs de generación de vínculos de correo electrónico, etc., solo se aplicarán dentro del alcance de este usuario.
Firma:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Crea una nueva cookie de sesión de Firebase con las opciones especificadas. La cadena de JWT creada se puede establecer como una cookie de sesión del servidor con una política de cookies personalizada y se puede usar para la administración de sesiones. El JWT de la cookie de sesión tendrá las mismas reclamaciones de carga útil que el token de ID proporcionado.
Consulta Administrar cookies de sesión para ver muestras de código y documentación detallada.
Firma:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| idToken | string | El token de ID de Firebase que se intercambia por una cookie de sesión. |
| SessionCookieOptions | SessionCookieOptions. | Son las opciones de cookies de sesión, que incluyen la duración personalizada de la sesión. |
Muestra:
Promesa<string>
Una promesa que se resuelve en función del é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 las reclamaciones decodificadas del token. De lo contrario, se rechaza la promesa.
Si se configura checkRevoked como verdadero, primero verifica si el usuario correspondiente está inhabilitado. Si es así, se genera un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente al token de ID. Si se invalida la sesión del usuario correspondiente, se genera un error auth/id-token-revoked. Si no se especifica, no se aplica la verificación.
Consulta Verificar tokens de ID para ver muestras de código y documentación detallada.
Firma:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| idToken | string | El token de ID que se debe verificar. |
| checkRevocado | booleano | Establece si se revocó el token de ID. Esto requiere una solicitud adicional al backend de Firebase Auth para verificar la hora tokensValidAfterTime del usuario correspondiente. Si no se especifica, no se aplica esta verificación adicional. |
Muestra:
Promesa<DecodedIdToken>
Una promesa que se cumple 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 las reclamaciones de cookies. Rechaza la promesa si no se pudo verificar la cookie.
Si se configura checkRevoked como verdadero, primero verifica si el usuario correspondiente está inhabilitado. De ser así, se mostrará un error auth/user-disabled. Si no es así, verifica si se revocó la sesión correspondiente a la cookie de sesión. Si se invalida la sesión del usuario correspondiente, se genera un error auth/session-cookie-revoked. Si no se especifica, no se realiza la verificación.
Consulta Cómo verificar las cookies de sesión para ver muestras de código y documentación detallada.
Firma:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| sessionCookie | string | La cookie de sesión que se verificará. |
| checkRevocado | booleano |
Muestra:
Promesa<DecodedIdToken>
Una promesa que se cumple 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.