mabl APIを使用すると、ワークスペースのメンバーシップの管理、ユーザーアクティビティの確認、アカウント全体のシート使用状況の追跡を、プログラムで行うことができます。これらのエンドポイントを使用して、メンバーシップをIDプロバイダーと同期したり、未使用のライセンスを回収したり、手動での監査なしでガバナンスダッシュボードを構築したりできます。
この記事では、よくある目的ごとに手順を説明します。
始める前に
ユーザー管理エンドポイントとワークスペース管理エンドポイントには、会社単位の ユーザー管理 APIキーが必要です。アカウント管理者は、会社ダッシュボードの [APIキー] タブから作成できます。詳しい手順については、APIキーの管理を参照してください。
また、いくつかの識別子が必要です。
- アカウントID: アカウントレベルのエンドポイントにはアカウントIDが必要です。会社ダッシュボードのアカウントドロップダウンから取得できます。
- ワークスペースID: ワークスペースレベルのエンドポイントにはワークスペースIDが必要です。アプリの [ワークスペース] > [ワークスペース] から取得できます。
- ユーザーID: メンバーシップエンドポイントが対象とするユーザーIDは、ユーザーのクエリーエンドポイントを使用して調べます。
APIを使わずにメンバーを表示する
ワークスペースに所属しているメンバーを確認するだけであれば、APIは必要ありません。アプリで [ワークスペース] > [チーム] からメンバーを表示するか、mabl CLIで mabl users list を実行します。
メンバーのオンボーディングとオフボーディング
これらのエンドポイントをIDツールやHRツールと連携することで、メンバーの参加、チーム異動、退職に合わせて、ワークスペースのメンバーシップを最新の状態に保てます。
-
メンバーのロールを変更する:
/workspaces/{workspace_id}/users/{id}にPATCHリクエストを送信し、新しいロール（所有者、編集者、または閲覧者）を指定します。チームメンバーのロールが変わるときに役立ちます。たとえば、ワークスペースを引き継ぐ編集者を所有者に昇格させる場合などです。 -
メンバーを削除する:
/workspaces/{workspace_id}/users/{id}にDELETEリクエストを送信します。オフボーディングのプロセスに組み込むと、メンバーの退職時にアクセス権が自動的に取り消されます。
どちらのエンドポイントも If-Match ヘッダーをサポートしているため、同時に行われた更新が互いを上書きすることはありません。また、どちらもワークスペースの最後の所有者が降格または削除されないように保護します。これにより、自動オフボーディングによってワークスペースの所有者が誤って不在になることを防げます。
未使用のライセンスを回収する
回収できるライセンスを見つけるには、各ワークスペースを手作業で確認するのではなく、アカウントレベルから始めます。
GET /accounts/{account_id}/users を呼び出すと、アカウント内のすべてのワークスペースのユーザーが、重複を除外したうえでアカウント単位のロールとともに一覧表示されます。inactive フィルターを追加すると、最近アクティビティのないユーザーのみが返されます。デフォルトでは「最近」は過去90日間を指します。任意の lookback_days パラメータを設定すると、この期間を広げたり狭めたりできます。
対応する前に候補を確認するには、GET /accounts/{account_id}/users/{id} で個々のユーザーを調べます。または、GET /accounts/{account_id}/users/{id}/activity で、最終アクティビティ日時、アクション総数、ワークスペースごとの内訳を確認します。
ユーザーがアクセス権を必要としないことを確認したら、上記のオフボーディング用エンドポイントを使用して削除します。
アクティビティとシートを監視する
mablは、各ユーザーをテスト作成アクティビティに基づいてオートメーターまたは参加者に分類します。これらのエンドポイントを使用して、その内訳を追跡し、シートの割り当てを実際の使用状況に合わせることができます。
GET /accounts/{account_id}/seats を呼び出すと、割り当て済み、使用中、利用可能なシート数のスナップショットを、オートメーターと参加者に分けて取得できます。
さらに詳しく確認するには、GET /accounts/{account_id}/seats/usage を呼び出して、指定した月のユーザーごとのシート使用状況を取得します。各ユーザーはオートメーターまたは参加者に分類されます。これを定期的なレポートに取り込むことで、オートメーターと参加者の比率を継続的に把握し、手動での監査なしでアカウントを適正な規模に調整できます。
会社のワークスペースを一覧表示する
会社全体を把握するには（ガバナンスダッシュボードの構築や、メンバーシップエンドポイントが対象とするワークスペースIDの確認のために）、GET /companies/{id}/workspaces を呼び出します。会社内のすべてのワークスペースが、所有するアカウントごとにグループ化されて返されます。
詳細情報
各エンドポイントのリクエストとレスポンスの詳細については、mabl APIリファレンスを参照してください。