Interface Auth com reconhecimento de locatário usada para gerenciar usuários, configurar provedores SAML/OIDC, gerar links de e-mail para redefinição de senha, verificação de e-mail etc. para locatários específicos.
O suporte à multilocação exige o Identity Platform (GCIP) do Google Cloud. Para saber mais sobre o GCIP, incluindo preços e recursos, consulte a documentação do GCIP.
Cada locatário contém seus próprios provedores de identidade, configurações e conjuntos de usuários. Com o TenantAwareAuth, os usuários de um locatário específico e as configurações OIDC/SAML correspondentes também podem ser gerenciadas, os tokens de ID para usuários que fizeram login em um locatário específico podem ser verificados e links de ação por e-mail também podem ser gerados para usuários que pertencem ao locatário.
Instâncias de TenantAwareAuth para um tenantId específico podem ser instanciadas chamando TenantManager.authForTenant().
Assinatura:
export declare class TenantAwareAuth extends BaseAuth
Estende: BaseAuth
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| tenantId (em inglês) | string | O identificador de locatário correspondente a essa instância de TenantAwareAuth. Todas as chamadas para APIs de gerenciamento de usuários, APIs de gerenciamento de provedores OIDC/SAML, APIs de geração de links de e-mail etc. só serão aplicadas no escopo deste locatário. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| createSessionCookie(idToken, sessionCookieOptions) (em inglês) | Cria um novo cookie de sessão do Firebase com as opções especificadas. A string JWT criada pode ser definida como um cookie de sessão do servidor com uma política de cookies personalizada e ser usada no gerenciamento de sessões. O JWT do cookie de sessão terá as mesmas declarações de payload que o token de ID fornecido.Consulte Gerenciar cookies de sessão para exemplos de código e documentação detalhada. | |
| verifyIdToken(idToken, checkScheduledd) | Verifica um token de ID do Firebase (JWT). Se o token for válido, a promessa será atendida com as declarações decodificadas do token. Caso contrário, a promessa é rejeitada.Se checkRevoked for definido como verdadeiro, primeiro verifica se o usuário correspondente está desativado. Em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao token de ID foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/id-token-revoked será gerado. Se não for especificada, a verificação não será aplicada.Consulte Verificar tokens de ID para ver exemplos de códigos e documentação detalhada. |
|
| verifySessionCookie(sessionCookie, check downloadd) | Verifica um cookie de sessão do Firebase. Retorna uma promessa com as declarações do cookie. Rejeita a promessa se não for possível verificar o cookie.Se checkRevoked estiver definido como verdadeiro, primeiro verificará se o usuário correspondente está desativado: em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/session-cookie-revoked será gerado. Se não for especificado, a verificação não será realizada.Consulte Verificar cookies de sessão para ver exemplos de código e documentação detalhada |
TenantAwareAuth.tenantId
O identificador de locatário correspondente a essa instância de TenantAwareAuth. Todas as chamadas para APIs de gerenciamento de usuários, APIs de gerenciamento de provedores OIDC/SAML, APIs de geração de links de e-mail etc. só serão aplicadas no escopo deste locatário.
Assinatura:
readonly tenantId: string;
TenantAwareAuth.createSessionCookie()
Cria um novo cookie de sessão do Firebase com as opções especificadas. A string JWT criada pode ser definida como um cookie de sessão do servidor com uma política de cookies personalizada e ser usada no gerenciamento de sessões. O JWT do cookie de sessão terá as mesmas declarações de payload que o token de ID fornecido.
Consulte Gerenciar cookies de sessão para ver exemplos de código e documentação detalhada.
Assinatura:
createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idToken | string | O token de ID do Firebase a ser trocado por um cookie de sessão. |
| sessionCookieOptions | SessionCookieOptions (em inglês) | As opções de cookie de sessão que incluem a duração da sessão personalizada. |
Retorna:
Promessa<string>
Uma promessa que se resolve em caso de sucesso com o cookie de sessão criado.
TenantAwareAuth.verifyIdToken()
Verifica um token de ID do Firebase (JWT). Se o token for válido, a promessa será atendida com as declarações decodificadas do token. Caso contrário, a promessa será recusada.
Se checkRevoked for definido como verdadeiro, primeiro vai verificar se o usuário correspondente está desativado. Em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao token de ID foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/id-token-revoked será gerado. Se não for especificado, a verificação não será aplicada.
Consulte Verificar tokens de ID para ver exemplos de código e documentação detalhada.
Assinatura:
verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| idToken | string | O token de ID a ser verificado. |
| checkRevogar | booleano | Define se o token de ID foi revogado ou não. Isso requer uma solicitação extra para o back-end do Firebase Auth para verificar o tempo de tokensValidAfterTime do usuário correspondente. Quando não é especificada, essa verificação adicional não é aplicada. |
Retorna:
Promessa<DeencodedIdToken>
uma promessa cumprida com as declarações decodificadas do token se o token de ID for válido; caso contrário, uma promessa rejeitada.
TenantAwareAuth.verifySessionCookie()
Verifica um cookie de sessão do Firebase. Retorna uma promessa com as declarações do cookie. Rejeita a promessa se não for possível verificar o cookie.
Se checkRevoked for definido como verdadeiro, primeiro vai verificar se o usuário correspondente está desativado. Em caso afirmativo, um erro auth/user-disabled será gerado. Em caso negativo, verifica se a sessão correspondente ao cookie de sessão foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/session-cookie-revoked será gerado. Se não for especificada, a verificação não será realizada.
Consulte Verificar cookies de sessão para ver exemplos de código e documentação detalhada.
Assinatura:
verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| sessionCookie | string | O cookie de sessão a ser verificado. |
| checkRevogar | booleano |
Retorna:
Promessa<DeencodedIdToken>
Uma promessa cumprida com as declarações decodificadas do cookie de sessão se o cookie de sessão for válido. caso contrário, uma promessa rejeitada.