新しいチーム用にワークスペースを立ち上げる、組織変更に合わせて名前を変更する、プロジェクトの終了に伴って廃止する。これらの作業はこれまで、アカウントダッシュボードで 1 つずつ操作する必要がありました。今後は、次の 3 つの操作をすべて mabl API から実行できます。
-
ワークスペースを作成する:
POST /companies/{company_id}/workspaces。ワークスペースの名前、所属するアカウント、所有者を指定します。所有者は、いずれかの mabl ワークスペースのメンバーである必要があります。 -
ワークスペースの名前を変更する:
PATCH /workspaces/{workspace_id}。 -
ワークスペースを削除する:
DELETE /workspaces/{workspace_id}。
製品、チーム、顧客ごとにワークスペースを用意しているチームであれば、ワークスペースのセットアップを手作業ではなく、オンボーディングプロセスのスクリプト化されたステップとして組み込めます。
アカウント管理者のみ
これら 3 つのエンドポイントは、アカウントダッシュボードで作成する新しい会社スコープの API キーの種類 Workspace lifecycle で認証されます。アカウントダッシュボードは、アカウント管理者の権限を持つワークスペースの所有者のみが利用できます。
お試しください
ワークスペース管理のエンドポイントを利用するには、会社スコープの「Workspace lifecycle」API キーが必要です。アカウント管理者は、アカウントダッシュボードの API keys セクションからこのキーを作成できます。
Workspace lifecycle キーは、会社が所有するすべてのワークスペースに対して有効です。このキーが持つ権限は、上記 3 つの操作とワークスペース設定の読み取りのみです。テスト結果の読み取り、ユーザーの管理、ワークスペース間でのテストのコピーはできません。
また、次の ID も必要です。
- 会社 ID: アカウントダッシュボードの API keys セクションにある View IDs から確認できます
- ワークスペース ID: mabl アプリの ワークスペース > ワークスペース から確認できます
作成時にクレジット割り当てを設定する
POST /companies/{company_id}/workspaces では、credit_allocation と enforce_credit_limit を指定できます。これらは、アカウントダッシュボードからワークスペースを追加するときに設定できる 2 つの項目と同じです。プロビジョニングスクリプトから、作成時に新しいワークスペースのクレジット上限を設定できるため、誰かが設定するまでアカウントの共有プールを消費し続けることがありません。なお、上限の適用にはクレジット割り当てが必要です。
ワークスペースの削除について
- ワークスペースの削除は取り消せず、API では復元できません。 この操作により、テスト、プラン、実行履歴もあわせて削除されます。削除したワークスペースの復元が必要な場合は、mabl のサポートにお問い合わせください。
- ワークスペースを削除しても、サブスクリプションは解約されません。 アカウントに残っている最後のワークスペースを削除するリクエストは拒否されるため、デコミッション用のスクリプトが請求アカウントのサブスクリプションを解約してしまうことはありません。
-
ワークスペースの削除はべき等ではありません。 mabl はワークスペースを検索する前に権限を確認するため、すでに削除済みのワークスペースを削除すると、成功ではなく
403が返されます。リトライ処理では、この点を考慮してください。