API キーの管理
API キーは認証用の一意の識別子として機能し、ユーザー、開発者、またはプログラムが API に安全にアクセスできるようにします。API キーは、悪用を防ぐために API の使用状況を追跡および制御するためによく使用されます。
テナントが新しいナビゲーション エクスペリエンスを使用している場合は、管理コンソール は管理アクティビティ センターに置き換えられます。
詳細は、新しいプラットフォーム ナビゲーションをご覧ください。
API キーの概要
管理コンソール の API キー セクションでは、テナントに関連付けられているすべての API キーを表示できます。名前、ID、または所有者でキーを検索できます。
API キーには次のステータスがあります。
- アクティブ: API キーは現在使用されています。
- 期限切れ: 有効期限が切れています。
- 取り消し済み: API キーは取り消されており、使用できなくなります。
テナント管理者は、API キーの生成を有効にしたり、API キーを監視したり取り消したりすることができます。API キーを生成、編集、または削除するには、開発者のロールが必要です。テナント管理者は、自分自身を含むユーザーにこのロールを割り当てることができます。
テナントでの API キーの有効化
既定では、API キーは無効化されています。テナント管理者は、テナント内で API キーを有効にすることができます。
次の手順を実行します。
- 管理コンソール で、[設定] に移動します。
- API キーセクションを見つけて、[API キーを有効にする] を選択します。
- 必要に応じて、次の設定を調整します。
トークンの最大有効期限を変更: 新しく生成されたトークンの有効期限を変更します。既存の API キーは、元の有効期限値を保持します。この値には上限はありません。
情報メモこの値への変更がユーザー プロファイル ページの API キー セクションに反映されることを確認するには、ブラウザを更新する必要がある場合があります。- ユーザーごとのアクティブな API キーの最大数を変更: この設定は、新しい API キーのみに影響します。制限に達すると、新しい API キーの作成は拒否されます。最大値は 1000 です。
-
API キーの生成を開始するには、[新規生成] をクリックします。これにより、ユーザー プロフィール ページの API キー セクションにリダイレクトされ、そこで新しいキーを作成できます。
API キーの生成
ハブから API キーを生成することができます。始める前に、次の要件を満たしていることを確認します。
-
アクティブなライセンスをお持ちです。
- [API キーを有効にする] が 管理コンソール でオンになっています。
- あなたには開発者ロールがあります。
次の手順を実行します。
-
右上隅にあるユーザー プロファイル アイコンをクリックし、[プロファイル設定] を選択します。
-
[API キー] セクションで、[新しいキーの生成] をクリックします。
-
API キーの説明と有効期限を入力します。
-
[生成] をクリックしてキーを作成します。
-
生成された API キーをすぐにコピーし、安全に保管します。後でキーを取得することはできません。
作成後、必要に応じて API キーの名前を編集したり、削除したりできます。
API キーを使用すると、Postman などのツールを使用して qlik.dev の REST API リファレンスを探索したり、qlik-cli をインストールしてコマンド ラインから Qlik 機能に直接アクセスしたりできます。詳細については、「Qlik API の概要と qlik-cli」を参照してください。
API キーの監視と取り消し
テナント管理者は、セキュリティ目的で API キーのアクティビティを監視することが重要です。不審なアクティビティが検出された場合は、API キーを取り消すことができます。
API キーを取り消すとすぐに非アクティブ化され、それに依存する進行中のプロセスや統合に影響することに注意してください。取り消しは元に戻すことができず、取り消された API キーを再度有効にすることはできません。
次の手順を実行します。
-
管理コンソール で、イベント セクションに移動します。
-
特定の API キーの過剰な使用など、不審なアクティビティがないか探してください。
-
イベントの横にある
をクリックして詳細を展開し、API キー ID をコピーします。 -
API キー セクションに移動し、その ID を使用して API キーを検索します。
-
キーの横にある
をクリックし、[取り消し] を選択します。ステータスがアクティブのキーのみを取り消すことができます。 -
複数の API キーを取り消すには、表内で API キーを選択し、右上隅にある [取り消し] をクリックします。
API キーの削除
API キーを削除すると、システムから完全に削除されます。API キーを削除すると元に戻すことはできず、そのアクセス権限が即座に削除されます。このアクションにより、キーに依存する進行中のプロセスや統合が中断されないことを確認してください。
API キーを削除するには、開発者ロールが必要です。
次の手順を実行します。
-
右上隅にあるユーザー プロファイル アイコンをクリックし、[プロファイル設定] を選択します。
-
API キー セクションを選択します。
-
削除する API キーの隣にある
をクリックし、 [削除] を選択します。 -
すべてのキーを削除する場合は、API キーのリストの上にある [すべて削除] をクリックします。