TenantManager class

定义租户管理器,用于帮助管理租户相关操作。这包括:

  • 能够创建、更新、列出、获取和删除基础项目的租户。
  • 获取TenantAwareAuth实例,用于在指定租户的上下文中运行 Auth 相关操作(用户管理、提供商配置管理、令牌验证、电子邮件链接生成等)。

签名:

export declare class TenantManager 

方法

方法修饰符描述
authForTenant(租户ID)返回绑定到给定租户 ID 的TenantAwareAuth实例。
创建租户(租户选项)创建一个新租户。创建新租户时,使用单独计费和配额的租户将需要自己的项目,并且必须定义为full_service
删除租户(租户ID)删除现有租户。
获取租户(租户ID)获取与给定tenantId对应的租户的租户配置。
列表租户(最大结果,pageToken)检索租户列表(仅限单个批次),其大小为maxResultspageToken指定的偏移量开始。用于批量检索指定项目的所有租户。
更新租户(租户ID,租户选项)更新现有租户配置。

TenantManager.authForTenant()

返回绑定到给定租户 ID 的TenantAwareAuth实例。

签名:

authForTenant(tenantId: string): TenantAwareAuth;

参数

范围类型描述
租户ID细绳要返回TenantAwareAuth实例的租户ID。

返回:

租户感知授权

与该租户标识符对应的TenantAwareAuth实例。

TenantManager.createTenant()

创建一个新租户。创建新租户时,使用单独计费和配额的租户将需要自己的项目,并且必须定义为full_service

签名:

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

参数

范围类型描述
租户选项创建租户请求要在要创建的新租户配置上设置的属性。

返回:

承诺<租户>

通过与新创建的租户相对应的租户配置来履行承诺。

TenantManager.deleteTenant()

删除现有租户。

签名:

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

参数

范围类型描述
租户ID细绳要删除的租户对应的tenantId

返回:

承诺<无效>

一旦租户被删除,空洞的承诺就兑现了。

TenantManager.getTenant()

获取给定tenantId对应的租户的租户配置

签名:

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

参数

范围类型描述
租户ID细绳与要获取其数据的租户对应的租户标识符。

返回:

承诺<租户>

通过租户配置对提供的tenantId履行承诺

TenantManager.listTenants()

检索租户列表(仅限单个批次),其大小为maxResults ,从pageToken指定的偏移量开始。用于批量检索指定项目的所有租户。

签名:

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

参数

范围类型描述
最大结果数字页面大小,如果未定义则为 1000。这也是允许的最大限制。
页面令牌细绳下一页标记。如果未指定,则返回从没有任何偏移量开始的租户。

返回:

Promise< ListTenantsResult >

通过一批下载的租户和下一页令牌来解决的承诺。

TenantManager.updateTenant()

更新现有租户配置。

签名:

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

参数

范围类型描述
租户ID细绳要删除的租户对应的tenantId
租户选项更新租户请求要更新所提供租户的属性。

返回:

承诺<租户>

更新租户数据履行了承诺。