mabl APIキーを使用すると、mablワークスペース内の情報にプログラムからアクセスできます。このガイドでは、APIキーの作成、管理、およびローテーションの方法について説明します。キーの種類の選択については、以下のAPIキーの種類をご参照ください。
アクセスとスコープ
APIキーのアクセスと使用は、ワークスペースの所有者のみに限定されています。スコープと権限の詳細については、APIキーの種類に関する記事をご覧ください。
ワークスペースAPIキー
APIページからAPIキーの作成、一時停止、再開、削除ができます：ワークスペース > API。
APIキーの作成
APIキーを作成するには、ワークスペースのOwner(所有者)権限を持つユーザが、[ワークスペース] > [API] に移動し、次の手順を実行します。
- [+ APIキーの作成] ボタンをクリックして [APIキーの作成] モーダルウィンドウを開きます。
- APIキーの種類を選択してください。
- APIキーの名前を指定します。
- オプション：キーの有効期限チェックボックスをオンにして、1〜365日の有効期限を設定します。
- [保存] ボタンをクリックします。
新しいAPIキーがAPIsページに表示され、必要に応じてキーの表示、コピー、一時停止、再開、削除を行うことができます。
ご注意
APIキーの有効期限は、新規作成時にのみ設定できます。既存のキーに有効期限を追加することはできません。
APIキーのローテーション
APIキーを定期的にローテーションすることで、クレデンシャルが漏洩するリスクを軽減できます。キーの作成時に有効期限を設定した場合、元のキーは期限切れになると自動的に機能しなくなります。mablは、有効期限が近づくと、以下のスケジュールでワークスペースの所有者に通知メールを送信します：
- 有効期限の7日前
- 有効期限の3日前
- 有効期限の1日前
- 有効期限日に
これらの通知をきっかけに、キーがまだ必要な場合はローテーションを行うか、有効期限が切れても問題ないかを確認してください。有効期限が切れると、キーは自動的に機能を停止します。手動での操作は不要です。
有効期限を使用してキーをローテーションするには：
- 同じタイプの新しい API キーを作成します（必要に応じて新しい有効期限を設定できます）。
- 新しいキー値で使用中のインテグレーションを更新してください。
- 元のキーをそのまま期限切れにしてください。追加の操作は必要ありません。
元のキーに有効期限がない場合は、新しいキーが機能することを確認した後、手動で無効にできます。
- 同じタイプの新しいAPIキーを作成します。
- 使用中のインテグレーションを新しいAPIキーの値で更新します。
- 元のAPIキーを一時停止します。
- 新しいキーでインテグレーションが期待どおりに動作することを確認してください。
- 元の一時停止中のAPIキーを削除します。
APIキーの一時無効化
APIキーを一時的に無効にするには、トグルをオフにしてください。
APIキーの再有効化
APIキーをオンに切り替えると、そのキーへのAPIアクセスはすぐに再有効化されます。
APIキーの削除
ゴミ箱アイコンをクリックすると、APIキーは完全に削除されます。
削除したAPIキーは復元できません
APIキーを削除する前に、そのキーが今後使用されないことを必ず確認してください。削除したAPIキーは復元できないため、そのキーを利用しているスクリプトやサービスはmablにアクセスできなくなります。このキーを使用しているクライアントは、以後、mablサービスにアクセスすることはできません。
スクリプトやサービスがこのAPIキーにまだアクセスしているかどうか不明な場合は、まずこのAPIキーを一時的に無効化してください。
会社APIキー
アカウント管理者は、会社ダッシュボードからユーザー管理APIキーを作成できます。
APIキータブを開き、キーを作成ボタンをクリックします。キーに名前を付け、有効期限の範囲を設定して、キーを作成をクリックします。
生成されたキーをコピーして、安全な場所に保存してください。この後、キーを再度取得することはできません。