mabl APIに、ワークスペースのメンバーシップを管理し、アカウント全体のユーザーアクティビティとシート使用状況を確認するためのエンドポイントが追加されました。これらを使用すると、ユーザーのプロビジョニングとオフボーディングを自動化したり、未使用のライセンスを回収したり、カスタムのガバナンスダッシュボードを構築したりできます。
始める前に
ユーザー管理エンドポイントとワークスペース管理エンドポイントには、会社単位の「ユーザー管理」APIキーが必要です。管理者は、会社ダッシュボードの [APIキー] セクションから作成できます。
アカウントレベルのエンドポイントにはアカウントIDが必要です。同じダッシュボードのアカウントドロップダウンから取得できます。
ワークスペースIDは、アプリの [ワークスペース] > [ワークスペース] から取得できます。
ワークスペースのメンバーシップを管理する
-
メンバーのロールを更新する:
PATCH /workspaces/{workspace_id}/users/{id}は、ワークスペース内の既存メンバーのロールを変更します。 -
メンバーを削除する:
DELETE /workspaces/{workspace_id}/users/{id}は、ワークスペースからメンバーを削除します。
これらのエンドポイントで使用するユーザーIDを取得するには、ユーザーのクエリーを使用します。
どちらのエンドポイントも、安全な同時更新のために If-Match をサポートしており、ワークスペースの最後の所有者が降格または削除されないように保護します。これらをID管理ツールと連携することで、ロールの割り当てとオフボーディングを自動化できます。
アカウント全体のユーザーを確認する
-
アカウントユーザーを一覧表示する:
GET /accounts/{account_id}/usersは、アカウントのワークスペース全体のすべてのユーザーを、重複を除外し、アカウント単位のロールとともに返します。inactiveフィルター（任意のlookback_daysウィンドウ、デフォルトは90）を追加すると、最近アクティビティのないユーザーのみが返されるため、回収できるライセンスを簡単に見つけられます。 -
アカウントユーザーを取得する:
GET /accounts/{account_id}/users/{id}は、アカウント内の単一ユーザーのロールを調べます。 -
アカウントユーザーのアクティビティを取得する:
GET /accounts/{account_id}/users/{id}/activityは、1人のユーザーのアクティビティを、アカウントのすべてのワークスペースにわたって返します。これには、最終アクティビティ日時、アクション総数、ワークスペースごとの内訳が含まれます。
シート使用状況を追跡する
-
アカウントのシートを取得する:
GET /accounts/{account_id}/seatsは、アカウントの割り当て済み、使用中、利用可能なシート数を、オートメーターと参加者に分けて返します。 -
アカウントのシート使用状況を取得する:
GET /accounts/{account_id}/seats/usageは、指定した月のユーザーごとのシート使用状況を返し、各ユーザーをオートメーターまたは参加者に分類します。
これらのエンドポイントを使用すると、オートメーターと参加者の比率を管理し、手動での監査なしでアカウントを適正な規模に調整できます。
会社のワークスペースを一覧表示する
-
会社のワークスペースを一覧表示する:
GET /companies/{id}/workspacesは、会社内のすべてのワークスペースを、所有するアカウントごとにグループ化して返します。
このエンドポイントを使用すると、ガバナンスレポートのために、会社のすべてのワークスペースの一覧を作成できます。
詳細情報
アカウント管理とユーザー管理のサンプルAPIワークフローについては、ドキュメントをご覧ください。