TenantManager class

Define o gerenciador de locatários usado para ajudar a gerenciar operações relacionadas ao locatário. Incluindo:

  • A capacidade de criar, atualizar, listar, receber e excluir locatários do projeto subjacente.
  • Receber 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 links 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 de TenantAwareAuth vinculada ao ID de locatário especificado.
createTenant(tenantOptions) (link em inglês) Cria um novo locatário. Ao criar novos locatários, os locatários que usam faturamento e cota separados vão exigir um projeto próprio e ser definidos como full_service.
deleteTenant(tenantId) Exclui um locatário atual.
getTenant(tenantId) (link em inglês) Recebe a configuração do locatário do locatário correspondente a um determinado tenantId.
listTenants(maxResults, pageToken) Recupera uma lista de locatários (somente lote único) com um tamanho de maxResults a partir do deslocamento especificado por pageToken. É usado para recuperar todos os locatários de um projeto especificado em lotes.
updateTenant(tenantId, tenantOptions) Atualiza uma configuração de locatário existente.

TenantManager.authForTenant()

Retorna uma instância de TenantAwareAuth vinculada ao ID de locatário especificado.

Assinatura:

authForTenant(tenantId: string): TenantAwareAuth;

Parâmetros

Parâmetro Tipo Descrição
tenantId string O ID de locatário com a instância TenantAwareAuth que será retornada.

Retorna:

TenantAwareAuth (link em inglês)

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

TenantManager.createTenant()

Cria um novo locatário. Ao criar novos locatários, os locatários que usam faturamento e cota separados vão exigir um projeto próprio e ser definidos como full_service.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
tenantOptions CreateTenantRequest (link em inglês) As propriedades a serem definidas na configuração do novo locatário que será criada.

Retorna:

Promessa<Locatário>

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

TenantManager.deleteTenant()

Exclui um locatário atual.

Assinatura:

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

Parâmetros

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

Retorna:

Promessa<void>

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

TenantManager.getTenant()

Recebe a configuração do locatário do locatário correspondente a um determinado tenantId.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
tenantId string O identificador de locatário correspondente ao locatário cujos dados serão buscados.

Retorna:

Promessa<Locatário>

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

TenantManager.listTenants()

Recupera uma lista de locatários (somente lote único) com um tamanho de maxResults a partir do deslocamento especificado por pageToken. É usado para recuperar todos os locatários de um projeto especificado em lotes.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
maxResults number O tamanho da página, 1.000, se indefinido. Esse também é o limite máximo permitido.
pageToken string O token da próxima página. Se não for especificado, retorna locatários começando sem qualquer deslocamento.

Retorna:

Promessa<ListTenantsResult>

Uma promessa que se resolve 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
tenantId string O tenantId correspondente ao locatário a ser excluído.
tenantOptions UpdateTenantRequest (link em inglês) As propriedades a serem atualizadas no locatário fornecido.

Retorna:

Promessa<Locatário>

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