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 para o projeto subjacente.
- Obtendo uma instância
TenantAwareAuth
para executar operações relacionadas ao Auth (gerenciamento de usuários, gerenciamento de configuração de provedor, verificação de token, geração de link de email 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. | |
createTenant(tenantOptions) | Cria um novo inquilino. Ao criar novos locatários, os locatários que usam cobrança e cota separados exigirão seu próprio projeto e devem ser definidos como full_service . | |
deleteTenant(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 de maxResults começando no deslocamento conforme especificado por pageToken . Isso é 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 TenantAwareAuth
vinculada ao ID do locatário fornecido.
Assinatura:
authForTenant(tenantId: string): TenantAwareAuth;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
ID do locatário | corda | A ID do locatário cuja instância TenantAwareAuth deve ser retornada. |
Devoluções:
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 faturamento e cota separados exigirão seu próprio projeto e devem ser definidos como full_service
.
Assinatura:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
Opções de locatário | CreateTenantRequest | As propriedades a serem definidas na nova configuração de locatário a ser criada. |
Devoluções:
Promessa < Locatário >
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 | Modelo | Descrição |
---|---|---|
ID do locatário | corda | O tenantId correspondente ao locatário a ser excluído. |
Devoluções:
Promessa<void>
Uma promessa vazia cumprida depois que o inquilino foi 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 | Modelo | Descrição |
---|---|---|
ID do locatário | corda | O identificador do locatário correspondente ao locatário cujos dados devem ser buscados. |
Devoluções:
Promessa < Locatário >
Uma promessa cumprida com a configuração do locatário para o tenantId
fornecido .
TenantManager.listTenants()
Recupera uma lista de locatários (somente lote único) com um tamanho de maxResults
começando do deslocamento conforme especificado por pageToken
. Isso é 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 | Modelo | Descrição |
---|---|---|
maxResults | número | O tamanho da página, 1000 se indefinido. Este também é o limite máximo permitido. |
pageToken | corda | O próximo token de página. Se não for especificado, retorna inquilinos iniciando sem nenhum deslocamento. |
Devoluções:
Promessa< ListTenantsResult >
Uma promessa que resolve com um lote de locatários baixados e o token da próxima página.
TenantManager.updateInquilino()
Atualiza uma configuração de locatário existente.
Assinatura:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
Parâmetros
Parâmetro | Modelo | Descrição |
---|---|---|
ID do locatário | corda | O tenantId correspondente ao locatário a ser excluído. |
Opções de locatário | UpdateTenantRequest | As propriedades a serem atualizadas no locatário fornecido. |
Devoluções:
Promessa < Locatário >
Uma promessa cumprida com os dados do locatário de atualização.