APIキーの管理

mabl APIキーを使用すると、mablワークスペース内の情報にプログラムからアクセスできます。このガイドでは、APIキーの作成、管理、およびローテーションの方法について説明します。キーの種類の選択については、以下のAPIキーの種類をご参照ください。

ワークスペースAPIキー

APIページからAPIキーの作成、一時停止、再開、削除ができます：ワークスペース > API。

APIキーの作成

APIキーを作成するには、ワークスペースのOwner(所有者)権限を持つユーザが、[ワークスペース] > [API] に移動し、次の手順を実行します。

1. [+ APIキーの作成] ボタンをクリックして [APIキーの作成] モーダルウィンドウを開きます。
2. APIキーの種類を選択してください。
3. APIキーの名前を指定します。
4. オプション：キーの有効期限チェックボックスをオンにして、1〜365日の有効期限を設定します。
5. [保存] ボタンをクリックします。

新しいAPIキーがAPIページに表示され、必要に応じてキーの表示、コピー、一時停止、再開、削除を行うことができます。

APIキーのローテーション

APIキーを定期的にローテーションすることで、クレデンシャルが漏洩するリスクを軽減できます。キーの作成時に有効期限を設定した場合、元のキーは期限切れになると自動的に機能しなくなります。mablは、有効期限が近づくと、以下のスケジュールでワークスペースの所有者に通知メールを送信します：

• 有効期限の7日前
• 有効期限の3日前
• 有効期限の1日前
• 有効期限日に

これらの通知をきっかけに、キーがまだ必要な場合はローテーションを行うか、有効期限が切れても問題ないかを確認してください。有効期限が切れると、キーは自動的に機能を停止します。手動での操作は不要です。

有効期限を使用してキーをローテーションするには：

1. 同じタイプの新しい API キーを作成します（必要に応じて新しい有効期限を設定できます）。
2. 新しいキー値で使用中のインテグレーションを更新してください。
3. 元のキーをそのまま期限切れにしてください。追加の操作は必要ありません。

元のキーに有効期限がない場合は、新しいキーが機能することを確認した後、手動で無効にできます。

1. 同じタイプの新しいAPIキーを作成します。
2. 使用中のインテグレーションを新しいAPIキーの値で更新します。
3. 元のAPIキーを一時停止します。
4. 新しいキーでインテグレーションが期待どおりに動作することを確認してください。
5. 元の一時停止中のAPIキーを削除します。

APIキーの一時無効化

APIキーを一時的に無効にするには、トグルをオフにしてください。

APIキーの再有効化

APIキーをオンに切り替えると、そのキーへのAPIアクセスはすぐに再有効化されます。

APIキーの削除

ゴミ箱アイコンをクリックすると、APIキーは完全に削除されます。

会社APIキー

会社APIキーは、単一のワークスペース内ではなく、会社が所有するすべてのワークスペースを対象に動作します。アカウント管理者権限を持つワークスペースの所有者は、アカウントダッシュボードから作成できます。

会社APIキーの各種類には、会社レベルの業務のうち1つの領域に対する権限が設定されています。それぞれがカバーする範囲については、APIキーの種類をご覧ください。

• レポーティング: 会社レベルのテスト実行状況のエンドポイント
• ユーザー管理: ユーザープロビジョニングとロール割り当て
• ワークスペースライフサイクル: ワークスペースの作成、名前の変更、削除

会社APIキーの作成

会社APIキーを作成するには、アカウント管理者がアカウントダッシュボードを開き、次の手順を実行します。

1. 左側のナビゲーションで [APIキー] をクリックします。
2. [キーを作成] ボタンをクリックします。
3. キーの名前を指定します。
4. APIキーの種類を選択します。
5. オプション：有効期限の範囲を設定します。
6. [キーを作成] ボタンをクリックします。

生成されたキーをコピーして、安全な場所に保存してください。この後、キーを再度取得することはできません。

会社APIキーの作成、変更、失効は、会社レベルのアクティビティフィードに記録されます。ワークスペースAPIキーは、そのワークスペースのアクティビティフィードに記録されます。