メイン コンテンツをスキップする

API キーの管理

API キーは、ユーザー、開発者、または API 呼び出しプログラムの認証のために使用される一意の識別子です。API キーは、インターフェースが使用される方法の追跡や制御、API の乱用防止によく使用されます。

API キーの概要

既定では、API キーは管理コンソールで無効化されています。API キーを有効にするには、[設定] セクションに移動します。テナント管理者は、API キーの取り消しや API キーの設定ができますが、API キーの生成または削除には、開発者のロールが必要です。開発者のロールは、テナント管理者によってユーザーに割り当てられます。あなたがテナント管理者である場合は、ご自身に開発者のロールを割り当てることができます。

API キー テーブルで表示される API キーの情報: 名前、ID、所有者、最終更新、作成日、有効期限、およびステータス。最初の 3 項目を検索するために使用する検索フィールド: [キー名]、[キー ID]、および[所有者]。

API キーのステータス

API キーには、次のステータスがあります。

  • アクティブ: API キーを使用中。
  • 有効期限切れ: 有効期限を超過。
  • 取り消し: API キーは取り消され、使用不可。

管理者として、管理コンソールの [イベント] セクションに登録された API キーのアクティビティを確認できます。特定の API キーが頻繁に使用されるなどの疑わしいアクティビティが検出された場合は、その API キーを取り消すことができます。テーブルの最右端にある矢印をクリックして詳細リストを開き、API キーの ID をコピーします。その後、取り消す API キーを見つけるために、API キー セクションにある ID を検索します。

API キーを 1 つ取り消すには、最右端にある [...] キーをクリックして、[取り消し] を選択します。取り消せるのは、ステータスが [アクティブ] のキーのみです。複数のキーを取り消すには、取り消すキーの左側にあるチェック ボックスを選択し、最右端にある [取り消し] をクリックします。取り消すと元に戻せず、取り消された API キーをもう一度アクティブ化することはできません。

取り消しに加えて、削除のオプションがあります。管理コンソールではなく、ハブから API キーを削除できます。

テナントでの API キーの有効化

[設定] ページの管理コンソールで、[API キーを有効化する] 設定がオンになっています。既定では、API キーは管理コンソールで無効化されています。

API キーのプロパティ
プロパティ 説明
API キーを有効にする

このスイッチは、テナントのすべての API キーを有効または無効にします。テナント管理者のみが、API キーを有効化できます。

トークンの最大有効期限を変更する

トークンの有効期限の値を変更することで、すべての新規トークンに新しい有効期限の値が設定されます。既存の API はこの変更の影響を受けず、有効期限値は以前と変わりません。

[ユーザーごとの最大 API キー数を変更する]

この設定は、新規の API キーのみに有効です。新規の API キーによって合計数が最大値を超えると、キーの作成は却下されます。

次の手順を実行します。

  1. 管理コンソールで、[設定] ページに移動します。
  2. [API キー] セクションで、[API キーを有効化する] ボタンをオンにします。
  3. 該当する場合は、[トークンの最大有効期限を変更する] と [ユーザーごとの最大 API キー数を変更する] 設定を変更します。

ハブからの API キーの生成

ハブから API キーを生成することができます。始める前に、次の 2 つの要件を満たしていることを確認します。

  • [有効] に設定 API 管理コンソールで [キー] がオンになっている。
  • テナント管理者があなたに [開発者] のロールを割り当て済み。

次の手順を実行します。

  1. テナント (例: https://<テナント名>.com) にログオンします。

  2. 右上隅のプロファイルをクリックして、[設定] を選択します。

  3. API [キー] を選択します。

  4. [新規] API [キー] をクリックします。

  5. API キーの説明を入力し、API キーの有効期限を選択します。

  6. [生成] をクリックします。

    API キーが生成されます。

  7. API キーをコピーして、安全な場所に保管します。

生成後、API キーの名称は編集可能です。キーの削除もできます。