mabl API キーは、mabl ワークスペース内の情報へのプログラムによるアクセスを可能にします。API キーは、作成、一時停止/解除、および削除することができます。APIキーを管理するには、「Settings > API」ページをご覧ください。

APIキーの種類

異なるAPIキーは、異なるユースケースに対してパーミッションが設定されています。キーには、特定のユースケースに必要な読み取り/書き込み権限しかありません。

利用可能なキーの種類は次のとおりです。

• Deployment Trigger - Deployments API でテストを開始し、Execution Result API でテスト結果を取得するために使用します。
• Command Line Interface - [mabl CLI(/docs/mabl-cliの概要)で使用します。
• CI/CD Integration - mablのJenkins、Bamboo、Microsoft Azure DevOps、GitHub Action、Octopus Deployなどの統合機能を使用することができます。
• Link Agent - mabl Linkエージェントとの併用
• Issue Tracker - mabl Jiraプラグインでの使用
• Integration - レガシーなAPIキータイプ。ユーザーが作成することはできません（非推奨）。

それぞれのキータイプの作成方法は以下の通りです。

📘

非推奨の Integration キータイプ

従来のIntegrationキータイプは廃止されました。既存のキーは引き続き機能しますが、ユーザーがこのタイプの新しいキーを作成することはできません。

APIキーの作成

APIキーの作成は、「Settings > API」ページから行います。新しいキーを作成するには、[API キーの作成] ボタンをクリックします。このボタンが表示されていない場合は、ワークスペースの所有者にキーの作成を依頼してください。

📘

APIキーを作成できる権限について

API キーを作成できるのは、ワークスペースの Owner レベルのユーザーのみです。

たとえば、Deployment Events API を使用して mabl テストを開始する curl スクリプトがあった場合、デプロイメントを開始および監視する権限を持つ Deployment Trigger API Key（以下の写真）を使用します。

キーを作成した後、「copy」または「eye」ボタンをクリックすると、それぞれこのAPIキーをコピーまたは表示することができます。

APIキーの一時停止とローテーション

セキュリティ意識の高いユーザーは、APIキーを削除したいが、そのキーが使用されているかどうかわからない場合があります。それぞれのキーのOn/OffボタンをOffに切り替えると、そのキーを使ったAPIアクセスを即座にブロックすることができます。Onに戻すと、そのキーでのAPIアクセスがすぐに有効になります。

APIキーをトグルすることで、APIキーの削除やローテーションの際に問題が発生しないようにすることができます。キーを一時停止した後に問題が検出されない場合は、「削除」ボタンをクリックしてキーを削除することができます（詳細は次のセクションで説明します）。

APIキーをローテーションする場合（例：Jenkinsのmablプラグインの場合）

1. 同じタイプの2つ目のキーを作成
2. 新しいキーの値でJenkinsインテグレーションを更新
3. それぞれのインテグレーションで使用中の既存のキーを一時停止
4. システム動作を確認した後、古い（一時停止中の）キーを削除

APIキーの削除

🚧

削除したAPIキーは復元できません

APIキーを削除する前に、APIキーが使用されていないことを確認してください。一度削除したAPIキーは元に戻すことができないため、影響を受けたスクリプトやサービスはmablにアクセスできなくなります。

APIキーを削除するには、DELETEボタンを使います。これにより、APIキーは永久に削除されます。このキーを使用しているクライアントは、今後mablのサービスにアクセスすることができません。キーを削除する前に、そのキーで今後アクセスする必要がないことを確認してください。確信が持てない場合は、キーを一時停止してください（前のセクションを参照）。