Interfaccia Auth tenant-aware utilizzata per la gestione degli utenti, la configurazione dei provider SAML/OIDC, la generazione di collegamenti e-mail per la reimpostazione della password, la verifica dell'e-mail, ecc. per tenant specifici.
Il supporto multi-tenancy richiede la piattaforma Identity di Google Cloud (GCIP). Per ulteriori informazioni su GCIP, inclusi prezzi e funzionalità, consulta la documentazione GCIP .
Ogni tenant contiene i propri provider di identità, impostazioni e set di utenti. Utilizzo di TenantAwareAuth , è inoltre possibile gestire gli utenti per un tenant specifico e le corrispondenti configurazioni OIDC/SAML, verificare i token ID per gli utenti che hanno effettuato l'accesso a un tenant specifico e generare collegamenti alle azioni e-mail per gli utenti appartenenti al tenant.
Le istanze TenantAwareAuth per un tenantId specifico possono essere istanziate chiamando TenantManager.authForTenant() .
Firma:
export declare class TenantAwareAuth extends BaseAuth
Estende: BaseAuth
Proprietà
| Proprietà | Modificatori | Tipo | Descrizione |
|---|---|---|---|
| inquilinoId | corda | L'identificatore del tenant corrispondente a questa istanza TenantAwareAuth . Tutte le chiamate alle API di gestione degli utenti, alle API di gestione dei provider OIDC/SAML, alle API di generazione di collegamenti di posta elettronica e così via verranno applicate solo nell'ambito di questo tenant. |
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) | Crea un nuovo cookie di sessione Firebase con le opzioni specificate. La stringa JWT creata può essere impostata come cookie di sessione lato server con una politica sui cookie personalizzata ed essere utilizzata per la gestione della sessione. Il cookie di sessione JWT avrà le stesse richieste di carico utile del token ID fornito. Consulta Gestire i cookie di sessione per esempi di codice e documentazione dettagliata. | |
| verificaIdToken(idToken, checkRevoked) | Verifica un token ID Firebase (JWT). Se il token è valido, la promessa viene mantenuta con le affermazioni decodificate del token; in caso contrario, la promessa viene respinta. Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato. In caso affermativo, viene generato un errore auth/user-disabled . In caso negativo, verifica se la sessione corrispondente al token ID è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/id-token-revoked . Se non specificato il controllo non viene applicato. Vedi Verifica token ID per esempi di codici e documentazione dettagliata. | |
| verificareSessionCookie(sessionCookie, checkRevoked) | Verifica un cookie di sessione Firebase. Restituisce una Promise con le attestazioni sui cookie. Rifiuta la promessa se non è stato possibile verificare il cookie. Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato: in caso affermativo, viene generato un errore auth/user-disabled . In caso negativo verifica se la sessione corrispondente al cookie di sessione è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/session-cookie-revoked . Se non specificato il controllo non viene eseguito. Consulta Verifica dei cookie di sessione per esempi di codice e documentazione dettagliata |
TenantAwareAuth.tenantId
L'identificatore del tenant corrispondente a questa istanza TenantAwareAuth . Tutte le chiamate alle API di gestione degli utenti, alle API di gestione dei provider OIDC/SAML, alle API di generazione di collegamenti di posta elettronica e così via verranno applicate solo nell'ambito di questo tenant.
Firma:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Crea un nuovo cookie di sessione Firebase con le opzioni specificate. La stringa JWT creata può essere impostata come cookie di sessione lato server con una politica sui cookie personalizzata ed essere utilizzata per la gestione della sessione. Il cookie di sessione JWT avrà le stesse richieste di carico utile del token ID fornito.
Consulta Gestire i cookie di sessione per esempi di codice e documentazione dettagliata.
Firma:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| idToken | corda | Il token ID Firebase da scambiare con un cookie di sessione. |
| sessionCookieOptions | SessionCookieOptions | Le opzioni dei cookie di sessione che includono la durata della sessione personalizzata. |
Ritorna:
Promesso<string>
Una promessa che si risolve in successo con il cookie di sessione creato.
TenantAwareAuth.verifyIdToken()
Verifica un token ID Firebase (JWT). Se il token è valido, la promessa viene mantenuta con le affermazioni decodificate del token; in caso contrario, la promessa viene respinta.
Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato. In caso affermativo, viene generato un errore auth/user-disabled . In caso negativo, verifica se la sessione corrispondente al token ID è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/id-token-revoked . Se non specificato il controllo non viene applicato.
Vedi Verifica token ID per esempi di codici e documentazione dettagliata.
Firma:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| idToken | corda | Il token ID da verificare. |
| checkRevocato | booleano | Se verificare se il token ID è stato revocato. Ciò richiede una richiesta aggiuntiva al backend Firebase Auth per controllare l'ora tokensValidAfterTime per l'utente corrispondente. Quando non specificato, questo controllo aggiuntivo non viene applicato. |
Ritorna:
Promessa< DecodedIdToken >
Una promessa mantenuta con le richieste decodificate del token se il token ID è valido; altrimenti, una promessa rifiutata.
TenantAwareAuth.verifySessionCookie()
Verifica un cookie di sessione Firebase. Restituisce una Promise con le attestazioni sui cookie. Rifiuta la promessa se non è stato possibile verificare il cookie.
Se checkRevoked è impostato su true, verifica innanzitutto se l'utente corrispondente è disabilitato: in caso affermativo, viene generato un errore auth/user-disabled . In caso negativo verifica se la sessione corrispondente al cookie di sessione è stata revocata. Se la sessione dell'utente corrispondente è stata invalidata, viene generato un errore auth/session-cookie-revoked . Se non specificato il controllo non viene eseguito.
Consulta Verifica dei cookie di sessione per esempi di codice e documentazione dettagliata
Firma:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| sessionCookie | corda | Il cookie di sessione da verificare. |
| checkRevocato | booleano |
Ritorna:
Promessa< DecodedIdToken >
Una promessa mantenuta con le affermazioni decodificate del cookie di sessione se il cookie di sessione è valido; altrimenti, una promessa rifiutata.