テナント関連の操作の管理に使用するテナント マネージャーを定義します。これも:
- 基礎となるプロジェクトのテナントを作成、更新、一覧表示、取得、削除する機能。
- 指定されたテナントのコンテキストで認証関連の操作 (ユーザー管理、プロバイダー構成管理、トークン検証、電子メール リンク生成など) を実行するための
TenantAwareAuth
インスタンスを取得します。
サイン:
export declare class TenantManager
メソッド
方法 | 修飾子 | 説明 |
---|---|---|
authForTenant(テナントID) | 指定されたテナント ID にバインドされたTenantAwareAuth インスタンスを返します。 | |
createTenant(テナントオプション) | 新しいテナントを作成します。新しいテナントを作成する場合、個別の請求とクォータを使用するテナントには独自のプロジェクトが必要であり、 full_service として定義する必要があります。 | |
deleteTenant(テナントID) | 既存のテナントを削除します。 | |
getTenant(テナントID) | 指定されたtenantId に対応するテナントのテナント構成を取得します。 | |
listTenants(maxResults, pageToken) | pageToken で指定されたオフセットから始まるmaxResults のサイズのテナントのリスト (単一バッチのみ) を取得します。これは、指定したプロジェクトのすべてのテナントをバッチで取得するために使用されます。 | |
updateTenant(tenantId, tenantOptions) | 既存のテナント構成を更新します。 |
TenantManager.authForTenant()
指定されたテナント ID にバインドされたTenantAwareAuth
インスタンスを返します。
サイン:
authForTenant(tenantId: string): TenantAwareAuth;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
テナントID | 弦 | TenantAwareAuth インスタンスが返されるテナント ID。 |
戻り値:
このテナント識別子に対応するTenantAwareAuth
インスタンス。
TenantManager.createTenant()
新しいテナントを作成します。新しいテナントを作成する場合、個別の請求とクォータを使用するテナントには独自のプロジェクトが必要となり、 full_service
として定義する必要があります。 。
サイン:
createTenant(tenantOptions: CreateTenantRequest): Promise<Tenant>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
テナントオプション | CreateTenantRequest | 作成される新しいテナント構成に設定するプロパティ。 |
戻り値:
プロミス<テナント>
新しく作成されたテナントに対応するテナント構成で履行される約束。
TenantManager.deleteTenant()
既存のテナントを削除します。
サイン:
deleteTenant(tenantId: string): Promise<void>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
テナントID | 弦 | 削除するテナントに対応するtenantId 。 |
戻り値:
約束<無効>
テナントが削除されると空の Promise が実行されます。
TenantManager.getTenant()
指定されたtenantId
に対応するテナントのテナント構成を取得します。
サイン:
getTenant(tenantId: string): Promise<Tenant>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
テナントID | 弦 | データを取得するテナントに対応するテナント識別子。 |
戻り値:
プロミス<テナント>
提供されたtenantId
に対するテナント構成で履行された Promise 。
TenantManager.listTenants()
pageToken
で指定されたオフセットから始まるmaxResults
のサイズのテナントのリスト (単一バッチのみ) を取得します。 。これは、指定したプロジェクトのすべてのテナントをバッチで取得するために使用されます。
サイン:
listTenants(maxResults?: number, pageToken?: string): Promise<ListTenantsResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
最大結果 | 番号 | ページ サイズ。未定義の場合は 1000。これは最大許容値でもあります。 |
ページトークン | 弦 | 次のページのトークン。指定しない場合は、オフセットなしで始まるテナントを返します。 |
戻り値:
Promise< ListTenantsResult >
ダウンロードされたテナントのバッチと次のページ トークンで解決される Promise。
TenantManager.updateTenant()
既存のテナント構成を更新します。
サイン:
updateTenant(tenantId: string, tenantOptions: UpdateTenantRequest): Promise<Tenant>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
テナントID | 弦 | 削除するテナントに対応するtenantId 。 |
テナントオプション | UpdateTenantRequest | 提供されたテナントで更新するプロパティ。 |
戻り値:
プロミス<テナント>
テナント データを更新することで約束が果たされました。