TenantAwareAuth class

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 para multilocação requer a plataforma de identidade do Google Cloud (GCIP). 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. Usando TenantAwareAuth , os usuários de um locatário específico e as configurações OIDC/SAML correspondentes também podem ser gerenciados, os tokens de ID para usuários conectados a um locatário específico podem ser verificados e links de ação de email também podem ser gerados para usuários pertencentes ao locatário.

Instâncias 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
inquilinoId		corda	O identificador de locatário correspondente a esta instância 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. serão aplicadas somente dentro do escopo deste locatário.

Métodos

Método	Modificadores	Descrição
createSessionCookie(idToken, sessionCookieOptions)		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 lado do servidor com uma política de cookies personalizada e usada para gerenciamento de sessão. O JWT do cookie de sessão terá as mesmas declarações de carga que o token de ID fornecido. Consulte Gerenciar cookies de sessão para obter exemplos de código e documentação detalhada.
verifyIdToken(idToken, checkRevoked)		Verifica um token de ID do Firebase (JWT). Se o token for válido, a promessa será cumprida com as declarações decodificadas do token; caso contrário, a promessa será rejeitada. Se checkRevoked estiver definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro auth/user-disabled será gerado. Se não, verifica se a sessão correspondente ao ID token 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 obter exemplos de código e documentação detalhada.
verifySessionCookie(sessionCookie, checkRevoked)		Verifica um cookie de sessão do Firebase. Retorna uma promessa com as reivindicações do cookie. Rejeita a promessa se o cookie não puder ser verificado. Se checkRevoked for definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado: se sim, um erro auth/user-disabled é lançado. Se não, 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á executada. Consulte Verificar cookies de sessão para exemplos de código e documentação detalhada

TenantAwareAuth.tenantId

O identificador de locatário correspondente a esta instância 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. serão aplicadas somente dentro do 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 lado do servidor com uma política de cookies personalizada e usada para gerenciamento de sessão. O JWT do cookie de sessão terá as mesmas declarações de carga que o token de ID fornecido.

Consulte Gerenciar cookies de sessão para obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
idToken	corda	O token de ID do Firebase a ser trocado por um cookie de sessão.
sessãoCookieOptions	SessãoCookieOptions	As opções de cookies de sessão que incluem duração de sessão personalizada.

Retorna:

Promessa<string>

Uma promessa que é resolvida com 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á cumprida com as declarações decodificadas do token; caso contrário, a promessa será rejeitada.

Se checkRevoked estiver definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado. Se sim, um erro auth/user-disabled será gerado. Se não, verifica se a sessão correspondente ao ID token foi revogada. Se a sessão do usuário correspondente for invalidada, um erro auth/id-token-revoked será lançado. Se não for especificado, a verificação não será aplicada.

Consulte Verificar tokens de ID para obter exemplos de código e documentação detalhada.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
idToken	corda	O token de ID a ser verificado.
verificarRevogado	boleano	Se deve verificar se o token de ID foi revogado. Isso requer uma solicitação extra ao back-end do Firebase Auth para verificar o tempo tokensValidAfterTime do usuário correspondente. Quando não especificada, esta verificação adicional não é aplicada.

Retorna:

Promessa< DecodedIdToken >

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 reivindicações do cookie. Rejeita a promessa se o cookie não puder ser verificado.

Se checkRevoked for definido como verdadeiro, primeiro verifica se o usuário correspondente está desabilitado: se sim, um erro auth/user-disabled é gerado. Se não, 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á executada.

Consulte Verificar cookies de sessão para exemplos de código e documentação detalhada

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
sessãoCookie	corda	O cookie de sessão a ser verificado.
verificarRevogado	boleano

Retorna:

Promessa< DecodedIdToken >

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.