定義用來協助管理用戶群相關作業的用戶群管理員。這類內容符合以下敘述：
- 可以建立、更新、列出、取得及刪除基礎專案的用戶群。
- 取得
TenantAwareAuth執行個體，以在指定用戶群內執行驗證相關作業 (使用者管理、提供者設定管理、權杖驗證、電子郵件連結產生等)。
簽名：
export declare class TenantManager
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| authForTenant(用戶群 Id) | 傳回與指定用戶群 ID 繫結的 TenantAwareAuth 執行個體。 |
|
| createTenant(用戶群選項) | 建立新的用戶群。建立新的用戶群時，採用不同計費方式和配額的用戶群會需要自己的專案，且必須定義為 full_service。 |
|
| deleteTenant(用戶群 Id) | 刪除現有的用戶群。 | |
| getTenant(用戶群 Id) | 取得對應特定 tenantId 的用戶群設定。 |
|
| listTenants(maxResults, pageToken) | 根據 pageToken 指定的偏移，擷取大小為 maxResults 的用戶群清單 (僅限單一批次)。可用來分批擷取指定專案的所有用戶群。 |
|
| updateTenant(用戶群 Id, 用戶群 Options) | 更新現有的用戶群設定。 |
TenantManager.authForTenant()
傳回與指定用戶群 ID 繫結的 TenantAwareAuth 執行個體。
簽名：
authForTenant(tenantId: string): TenantAwareAuth;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 用戶群 ID | 字串 | 要傳回其 TenantAwareAuth 執行個體的用戶群 ID。 |
傳回：
與這個用戶群 ID 相對應的 TenantAwareAuth 執行個體。
TenantManager.createTenant()
建立新的用戶群。建立新的用戶群時，採用個別計費方式和配額的用戶群會需要自己的專案，且必須定義為 full_service。
簽名：
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 用戶群選項 | CreateTenantRequest | 要建立新用戶群設定上的屬性。 |
傳回：
承諾<用戶群>
已實現與新建用戶群相對應的用戶群設定的承諾。
TenantManager.deleteTenant()
刪除現有的用戶群。
簽名：
deleteTenant(tenantId: string): Promise<void>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 用戶群 ID | 字串 | 與要刪除的用戶群對應的 tenantId。 |
傳回：
承諾<void>
刪除用戶群後，保證會實現空白。
TenantManager.getTenant()
取得對應特定 tenantId 的用戶群設定。
簽名：
getTenant(tenantId: string): Promise<Tenant>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 用戶群 ID | 字串 | 與待擷取資料的用戶群相對應的用戶群 ID。 |
傳回：
承諾<用戶群>
具備提供給所提供 tenantId 的用戶群設定保證。
TenantManager.listTenants()
根據 pageToken 指定的偏移，擷取大小為 maxResults 的用戶群清單 (僅限單一批次)。可用來分批擷取指定專案的所有用戶群。
簽名：
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| maxResults | 數字 | 頁面大小，如未定義，則為 1000。同時也是允許的上限。 |
| pageToken | 字串 | 下一頁符記。如未指定，系統會傳回從沒有偏移量開始的用戶群。 |
傳回：
Promise<ListTenantsResult>
以一批下載的用戶群和下一頁符記解決的承諾。
TenantManager.updateTenant()
更新現有的用戶群設定。
簽名：
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 用戶群 ID | 字串 | 與要刪除的用戶群對應的 tenantId。 |
| 用戶群選項 | UpdateTenantRequest | 要在所提供用戶群中更新的屬性。 |
傳回：
承諾<用戶群>
已承諾提供更新用戶群資料。