テナント関連のオペレーションの管理に役立つテナント マネージャーを定義します。これには次のものが含まれます。
- 基盤となるプロジェクトのテナントを作成、更新、一覧表示、取得、削除する権限。
- 指定されたテナントのコンテキストで Auth 関連のオペレーション（ユーザー管理、プロバイダ構成管理、トークン検証、メールリンク生成など）を実行するための
TenantAwareAuthインスタンスを取得します。
署名:
export declare class TenantManager
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| authForTenant(tenantId) | 指定されたテナント ID にバインドされた TenantAwareAuth インスタンスを返します。 |
|
| createTenant(tenantOptions) | 新しいテナントを作成します。新しいテナントを作成する場合、個別の課金と割り当てを使用するテナントには独自のプロジェクトが必要であり、full_service として定義する必要があります。 |
|
| deleteTenant(tenantId) | 既存のテナントを削除します。 | |
| getTenant(tenantId) | 指定された tenantId に対応するテナントのテナント構成を取得します。 |
|
| listTenants(maxResults, pageToken) | pageToken で指定されたオフセットから始まる、サイズが maxResults のテナントのリスト（単一バッチのみ）を取得します。これは、指定したプロジェクトのすべてのテナントをバッチで取得するために使用されます。 |
|
| updateTenant(tenantId, tenantOptions) | 既存のテナント構成を更新します。 |
TenantManager.authForTenant()
指定されたテナント ID にバインドされた TenantAwareAuth インスタンスを返します。
署名:
authForTenant(tenantId: string): TenantAwareAuth;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| tenantId | 文字列 | TenantAwareAuth インスタンスが返されるテナント ID。 |
戻り値:
このテナント ID に対応する TenantAwareAuth インスタンス。
TenantManager.createTenant()
新しいテナントを作成します。新しいテナントを作成する場合、個別の課金と割り当てを使用するテナントには独自のプロジェクトが必要であり、full_service として定義する必要があります。
署名:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| テナンシー オプション | CreateTenantRequest | 作成する新しいテナント構成に設定するプロパティ。 |
戻り値:
Promise <テナント>
新しく作成されたテナントに対応するテナント構成で履行される Promise。
TenantManager.deleteTenant()
既存のテナントを削除します。
署名:
deleteTenant(tenantId: string): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| tenantId | 文字列 | 削除するテナントに対応する tenantId。 |
戻り値:
約束 <void>
テナントが削除されると、空の Promise が履行されます。
TenantManager.getTenant()
指定された tenantId に対応するテナントのテナント構成を取得します。
署名:
getTenant(tenantId: string): Promise<Tenant>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| tenantId | 文字列 | データを取得するテナントに対応するテナント ID。 |
戻り値:
Promise <テナント>
指定された tenantId へのテナント構成で履行された Promise。
TenantManager.listTenants()
pageToken で指定されたオフセットから始まる、サイズが maxResults のテナントのリスト（単一バッチのみ）を取得します。これは、指定したプロジェクトのすべてのテナントをバッチで取得するために使用されます。
署名:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| maxResults | 数値 | ページサイズ（未定義の場合は 1, 000）。これが最大許容上限でもあります。 |
| pageToken | 文字列 | 次のページトークン。指定しない場合、オフセットなしで開始するテナントを返します。 |
戻り値:
Promise <ListTenantsResult>
ダウンロードしたテナントのバッチと次のページトークンで解決される Promise。
TenantManager.updateTenant()
既存のテナント構成を更新します。
署名:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| tenantId | 文字列 | 削除するテナントに対応する tenantId。 |
| テナンシー オプション | UpdateTenantRequest | 指定されたテナントで更新するプロパティ。 |
戻り値:
Promise <テナント>
テナントデータの更新で履行された Promise。