TenantManager class

Define o gerenciador de locatários usado para ajudar a gerenciar operações relacionadas a locatários. Isso inclui:

  • A capacidade de criar, atualizar, listar, obter e excluir locatários do projeto subjacente.
  • Obter uma instância TenantAwareAuth para executar operações relacionadas ao Auth (gerenciamento de usuários, gerenciamento de configuração do provedor, verificação de token, geração de link de e-mail, etc.) no contexto de um locatário especificado.

Assinatura:

export declare class TenantManager

Métodos

Método Modificadores Descrição
authForTenant(tenantId) Retorna uma instância TenantAwareAuth vinculada ao ID do locatário fornecido.
criarTenant(tenantOptions) Cria um novo inquilino. Ao criar novos locatários, os locatários que usam cobrança e cota separadas exigirão seu próprio projeto e deverão ser definidos como full_service .
excluirTenant(tenantId) Exclui um locatário existente.
getTenant(tenantId) Obtém a configuração do locatário correspondente a um determinado tenantId .
listTenants(maxResults, pageToken) Recupera uma lista de locatários (somente lote único) com um tamanho maxResults começando no deslocamento especificado por pageToken . Isso é usado para recuperar todos os inquilinos de um projeto especificado em lotes.
atualizarTenant(tenantId, locatárioOptions) Atualiza uma configuração de locatário existente.

TenantManager.authForTenant()

Retorna uma instância TenantAwareAuth vinculada ao ID do locatário fornecido.

Assinatura:

authForTenant(tenantId: string): TenantAwareAuth;

Parâmetros

Parâmetro Tipo Descrição
inquilinoId corda O ID do locatário cuja instância TenantAwareAuth deve ser retornada.

Retorna:

TenantAwareAuth

A instância TenantAwareAuth correspondente a esse identificador de locatário.

TenantManager.createTenant()

Cria um novo inquilino. Ao criar novos locatários, os locatários que usam cobrança e cota separadas exigirão seu próprio projeto e deverão ser definidos como full_service .

Assinatura:

createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;

Parâmetros

Parâmetro Tipo Descrição
opções de inquilino CriarTenantRequest As propriedades a serem definidas na nova configuração de locatário a ser criada.

Retorna:

Promessa< Inquilino >

Uma promessa cumprida com a configuração do locatário correspondente ao locatário recém-criado.

TenantManager.deleteTenant()

Exclui um locatário existente.

Assinatura:

deleteTenant(tenantId: string): Promise<void>;

Parâmetros

Parâmetro Tipo Descrição
inquilinoId corda O tenantId correspondente ao locatário a ser excluído.

Retorna:

Promessa<void>

Uma promessa vazia cumprida depois que o locatário for excluído.

TenantManager.getTenant()

Obtém a configuração do locatário correspondente a um determinado tenantId .

Assinatura:

getTenant(tenantId: string): Promise<Tenant>;

Parâmetros

Parâmetro Tipo Descrição
inquilinoId corda O identificador do locatário correspondente ao locatário cujos dados serão buscados.

Retorna:

Promessa< Inquilino >

Uma promessa cumprida com a configuração do locatário para o tenantId fornecido .

TenantManager.listInquilinos()

Recupera uma lista de locatários (somente lote único) com um tamanho de maxResults começando no deslocamento especificado por pageToken . Isso é usado para recuperar todos os inquilinos de um projeto especificado em lotes.

Assinatura:

listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;

Parâmetros

Parâmetro Tipo Descrição
maxResultados número O tamanho da página, 1000 se indefinido. Este também é o limite máximo permitido.
token de página corda O token da próxima página. Se não for especificado, retorna inquilinos começando sem qualquer compensação.

Retorna:

Promessa< ListTenantsResult >

Uma promessa que é resolvida com um lote de locatários baixados e o token da próxima página.

TenantManager.updateTenant()

Atualiza uma configuração de locatário existente.

Assinatura:

updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;

Parâmetros

Parâmetro Tipo Descrição
inquilinoId corda O tenantId correspondente ao locatário a ser excluído.
opções de inquilino AtualizarTenantRequest As propriedades a serem atualizadas no locatário fornecido.

Retorna:

Promessa< Inquilino >

Uma promessa cumprida com a atualização dos dados do locatário.