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
租戶選項更新租戶請求若要更新所提供租戶的屬性。

返回:

承諾<租戶>

更新租戶資料履行了承諾。