mablのAPIキーを使用すると、mablワークスペースの情報に外部のプログラムからアクセスできます。このガイドでは、mablのAPIキーの種類とそれぞれの管理方法について概要を説明します。
ご注意:
APIキーにアクセス、かつ利用できるユーザーは、ワークスペースのOwner(所有者)に限定されています。
APIキーの種類
利用できるAPIキーは用途ごとに異なります。キーは、特定の用途に必要な読み取り/書き込み権限のみを保有します。
mablで使用可能なAPIキーの種類と用途については、次の表を参照してください。
| APIキーの種類 | 用途 |
|---|---|
| CI/CD Integration | Jenkins、Bamboo、Microsoft Azure DevOps、GitHub Actions、Octopus Deployなど、mablのCI/CDインテグレーションで使用します。 |
| Command Line Interface | mabl CLIで使用します。 |
| Deployment Trigger | Deployment Events APIでテストを開始し、Execution Result APIでテスト結果を取得するために使用します。 |
| Issue Tracker | mabl Jiraプラグインで使用します。 |
| Link Agent | mabl Link Agentで使用します。 |
| Java Selenium Agent | Selenium Java Agentで使用します。 |
| Usage Analytics | mabl Segmentインテグレーションで使用します。 |
| Viewer | mabl レポーティングAPI など、読み取り専用のAPIエンドポイントで使用します |
APIキーの種類 Integration は廃止されました。既存の Integrationキーは引き続き機能しますが、この種類の新しいAPIキーを作成することはできません。
APIキーの管理
[ワークスペース] > [API] にあるAPIキー管理ページで、APIキーの作成、一時無効化、再有効化、削除を行うことができます。
APIキー管理ページ
APIキーの作成
APIキーを作成するには、ワークスペースのOwner(所有者)権限を持つユーザが、[ワークスペース] > [API] に移動し、次の手順を実行します。
- [+ APIキーの作成] ボタンをクリックして [APIキーの作成] モーダルウィンドウを開きます。
- APIキーの種類を選択します。
- APIキーの名前を指定します。
- [保存] ボタンをクリックします。
[API] ページに新しいAPIキーが表示されます。このページでは、キーの表示、コピー、一時無効化、再有効化、削除を行うことができます。
APIキーのコピー
APIキーの一時無効化
APIキーをオフに切り替えて、一時的にAPIアクセスをブロックできます。APIキーを削除したいが、まだ使用されているかどうか不明な場合など、APIキーを一時的に無効化することができます。
たとえば、APIキーをローテーションしている場合、次の手順を実行します。
- 同じタイプの新しいAPIキーを作成します。
- 使用中のインテグレーションを新しいAPIキーの値で更新します。
- 使用中のインテグレーションで使用されていた元のAPIキーを一時的に無効化します。
- 新しいAPIキーでインテグレーションが期待どおりに動作することを確認します。
- 一時的に無効化した元のAPIキーを削除します。
APIキーの再有効化
APIキーをオンに切り替えると、そのキーへのAPIアクセスはすぐに再有効化されます。
APIキーの削除
ゴミ箱アイコンをクリックすると、APIキーは完全に削除されます。
削除したAPIキーは復元できません
APIキーを削除する前に、そのキーが今後使用されないことを必ず確認してください。削除したAPIキーは復元できないため、そのキーを利用しているスクリプトやサービスはmablにアクセスできなくなります。このキーを使用しているクライアントは、以後、mablサービスにアクセスすることはできません。
スクリプトやサービスがこのAPIキーにまだアクセスしているかどうか不明な場合は、まずこのAPIキーを一時的に無効化してください。