mablのAPIキーは、ユースケースごとに異なる権限が設定されています。各キーには、特定のユースケースに必要な読み取り/書き込み権限のみが付与されています。mablでのAPIキーの操作については、APIキーの管理をご覧ください。
APIキーの種類は、2つのグループに分かれます。
- ワークスペースAPIキーは、単一のワークスペース内で動作し、ワークスペースの所有者が ワークスペース > API から作成します。
- 会社APIキーは、会社が所有するすべてのワークスペースを対象に動作し、会社の管理者が会社ダッシュボードから作成します。
ワークスペースAPIキー
| APIキーの種類 | 用途 |
|---|---|
| CI/CDインテグレーション | mablのCI/CD連携（Jenkins、Bamboo、Microsoft Azure DevOps、GitHub Actions、Octopus Deployなど）と組み合わせてご利用ください。 |
| コマンドラインインターフェース | mabl CLIで使用します。 |
| デプロイメントトリガー | デプロイメントイベントAPIでテストを開始したり、実行結果APIでテスト結果を取得したりする際に使用します。 |
| 編集者 | 「 編集者ロール」で許可されているアクションを実行するために使用します。 |
| イシュー管理 | mabl Jiraプラグインで使用します。 |
| Java Seleniumエージェント | Java Seleniumエージェントで使用します。 |
| リンクエージェント | mabl Link Agentで使用します。 |
| 利用状況の分析 | mabl Segmentインテグレーションで使用します。 |
| 閲覧者 | 読み取り専用のmabl APIエンドポイント（レポーティングAPIなど）に使用します。 |
| ワークスペース管理者 | クレデンシャルおよびリンクエージェントの読み取り/書き込み権限に使用します。 |
APIキーの種類 Integration は廃止されました。既存の Integrationキーは引き続き機能しますが、この種類の新しいAPIキーを作成することはできません。
会社APIキー
会社APIキーは、会社の管理者が利用できます。各種類には、会社レベルの業務のうち1つの領域に対する権限のみが設定されているため、ワークスペースをプロビジョニングするスクリプトが、テスト結果を読み取ったりユーザーを管理したりすることはできません。
| APIキーの種類 | 用途 |
|---|---|
| Link Agent | 会社内のすべてのワークスペースが使用できる会社スコープのLinkトンネルを提供するLink Agentの起動に使用します。 |
| レポーティング | 会社レベルのテスト実行状況のエンドポイントで使用します。アカウントレベルのテスト実行回数、実行秒数、最大同時実行数などを取得できます。 |
| ユーザー管理 | 会社レベルでのユーザープロビジョニングおよびロール割り当ての自動化に使用します。mabl APIでワークスペースとユーザーを管理するをご覧ください。 |
| ワークスペースライフサイクル | 会社レベルでのワークスペースの作成、名前の変更、削除に使用します。ワークスペース設定への読み取りアクセスも含まれます。mabl APIでワークスペースとユーザーを管理するをご覧ください。 |
ワークスペース管理者キーとワークスペースライフサイクルキーの違い
この2つの種類は名前が似ていますが、スコープと目的が異なります。ワークスペース管理者は、1つのワークスペース内でクレデンシャルとリンクエージェントを管理するためのワークスペースAPIキーです。ワークスペースライフサイクルは、会社全体でワークスペースの作成、名前の変更、削除を行うための会社APIキーです。