TenantManager class

定义用于管理租户相关操作的租户管理员。其中包括：

  • 能够创建、更新、列出、获取和删除底层项目的租户。
  • 获取 TenantAwareAuth 实例，以便在指定租户的上下文中运行与身份验证相关的操作（用户管理、提供方配置管理、令牌验证、电子邮件链接生成等）。

签名：

export declare class TenantManager

方法

方法 修饰符 说明
authForTenant(tenantId) 返回绑定到指定租户 ID 的 TenantAwareAuth 实例。
createTenant(tenantOptions) 创建新租户。创建新租户时，使用单独结算和配额的租户将需要自己的项目，并且必须定义为 full_service。
deleteTenant(tenantId) 删除现有租户。
getTenant(tenantId) 获取与指定 tenantId 对应的租户的租户配置。
listTenants(maxResults, pageToken) 检索大小为 maxResults 的租户列表（仅限单批次），从 pageToken 指定的偏移量开始。这用于批量检索指定项目的所有租户。
updateTenant(tenantId, tenantOptions) 更新现有租户配置。

TenantManager.authForTenant()

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

签名：

authForTenant(tenantId: string): TenantAwareAuth;

参数

参数 类型 说明
tenantId 字符串 要返回其 TenantAwareAuth 实例的租户 ID。

返回：

TenantAwareAuth

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

TenantManager.createTenant()

创建新租户。创建新租户时，使用单独结算和配额的租户将需要使用自己的项目，并且必须定义为 full_service。

签名：

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

参数

参数 类型 说明
tenantOptions CreateTenantRequest 要在要创建的新租户配置上设置的属性。

返回：

Promise<租户>

使用与新创建的租户对应的租户配置执行的 promise。

TenantManager.deleteTenant()

删除现有租户。

签名：

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

参数

参数 类型 说明
tenantId 字符串 与要删除的租户对应的 tenantId。

返回：

承诺<void>

删除租户后执行一个空 promise。

TenantManager.getTenant()

获取与指定 tenantId 对应的租户的租户配置。

签名：

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

参数

参数 类型 说明
tenantId 字符串 要提取其数据的租户对应的租户标识符。

返回：

Promise<租户>

通过提供的 tenantId 的租户配置执行的 promise。

TenantManager.listTenants()

检索大小为 maxResults 的租户列表（仅限单批次），从 pageToken 指定的偏移量开始。这用于批量检索指定项目的所有租户。

签名：

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

参数

参数 类型 说明
maxResults 数字 页面大小，如果未定义，则为 1000。这也是允许的上限。
pageToken 字符串 下一页令牌。如果未指定，则返回不带任何偏移量的租户。

返回：

Promise<ListTenantsResult>

通过一批下载的租户和下一个页面令牌进行解析的 promise。

TenantManager.updateTenant()

更新现有租户配置。

签名：

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

参数

参数 类型 说明
tenantId 字符串 与要删除的租户对应的 tenantId。
tenantOptions UpdateTenantRequest 要在提供的租户上更新的属性。

返回：

Promise<租户>

使用更新租户数据执行的 promise。