API キーの管理
API キーは認証に使用される一意の識別子であり、ユーザー、開発者、またはプログラムが API に安全にアクセスできるようにします。API キーは API の使用状況を追跡および制御するために不可欠であり、不正使用を防止して、安全な通信を確保するのに役立ちます。
API キーを使用してQlik Cloud API に接続する
API キーを使用して、Qlik REST API リファレンスと対話できます。API アクセスには、Postman や qlik-cli などのツールを使用できます。詳細については、「Qlik API の概要と qlik-cli」を参照してください。
例: Postman を使用して Qlik API に接続する
次の手順を実行します。
-
Postman を起動します。
-
HTTP メソッドを GET に設定します。
-
Qlik Cloud API エンドポイントの URL を入力します。
たとえば、テナント内のすべてのスペースを一覧表示するには、次を実行します。
https://your-tenant.eu.qlikcloud.com/api/v1/spaces
-
[認証] タブで、 [認証タイプ] として [ベアラー トークン] を選択します。
-
[トークン] 項目に API キーを入力します。
-
[送信] をクリックします。
リクエストが成功すると、API は JSON 応答を返します。この例では、応答にスペースのリストが含まれます。
テナントでの API キーの有効化
テナント管理者は、ユーザーがテナント内の API キーを生成できるかどうかを制御できます。
次の手順を実行します。
- Administration アクティビティ センターで、 [設定] に移動します。
- [API キー] で、[API キーを有効にする] をオンまたはオフにします。
API キー設定の構成
次の手順を実行します。
-
Administration アクティビティ センターで、 [設定] > [API キー] に移動します。
-
必要に応じて、次の設定を調整します。
-
トークンの最大有効期限を変更: 新しく生成された API トークンの有効期限を設定します。既存の API キーは、元の有効期限値を保持します。この値に上限はありません。
- ユーザーごとのアクティブ API キーの最大数を変更: ユーザーが持つことのできる API キーの上限を設定します。この制限は新しいキーにのみ適用されます。上限に達すると、ユーザーは追加のキーを作成できなくなります。最大値は 1000 です。
-
変更がユーザー プロファイル ページの API キー セクションに反映されることを確認するには、ブラウザを更新する必要がある場合があります。
API キーの生成と管理
API キーの生成
新しい API キーを生成するには、[API キーの管理] 権限を持つカスタム ロールを持つか、または [ユーザーのデフォルト設定] でこの権限を有効にする必要があります。
次の手順を実行します。
-
ユーザー プロファイル アイコンをクリックして、 [プロファイル設定] を選択します。
-
[API キー] セクションに移動して、 [新規キーの生成] をクリックします。
-
API キーの説明を入力して、有効期限を設定します。
-
[生成] をクリックしてキーを作成します。
-
生成された API キーをコピーして、安全に保管します。後でキーを取得することはできませんのでご注意ください。
API キーの編集
API キーの名前は、作成後に変更できます。
API キーの削除
次の手順を実行します。
-
ユーザー プロファイル アイコンをクリックして、 [プロファイル設定] を選択します。
-
[API キー] セクションに移動します。
-
削除する API キーの隣にある
をクリックし、 [削除] を選択します。 -
すべてのキーを削除するには、キーのリストの上部にある [すべて削除] をクリックします。
API キーの監視と取り消し
Administration アクティビティ センターの [API キー] セクションで、テナントに関連付けられているすべての API キーを表示できます。名前、ID、または所有者でキーを検索できます。
API キーのステータス
API キーには次のステータスがあります。
- アクティブ: API キーは現在使用されています。
- 期限切れ: 有効期限が切れています。
- 取り消し済み: API キーは取り消されており、使用できなくなります。
API キーの取り消し
テナント管理者として、API キーのアクティビティを積極的に監視することは、セキュリティを維持するために不可欠です。不審なアクティビティが検出された場合は、API キーを取り消すことができます。
次の手順を実行します。
-
Administration アクティビティ センターで、 [イベント] に移動します。
-
特定の API キーの過剰な使用など、不審なアクティビティがないか探してください。
-
イベントの横にある
をクリックして詳細を展開し、API キー ID をコピーします。 -
API キー セクションに移動し、その ID を使用して API キーを検索します。
-
キーの横にある
をクリックし、[取り消し] を選択します。ステータスがアクティブのキーのみを取り消すことができます。 -
複数の API キーを取り消すには、表内で API キーを選択し、右上隅にある [取り消し] をクリックします。
API キー管理のベスト プラクティス
-
キーの機密性を保つ: API キーを安全に保存し、パブリック コード リポジトリに公開されないようにします。
-
定期的に再生成する: セキュリティを強化するために、API キーを定期的に再生成します。
-
使用状況を監視する: API キーのアクティビティを定期的にチェックし、不審な動作を特定します。