メイン コンテンツをスキップする 補完的コンテンツへスキップ

API キーの管理

API キーは認証に使用される一意の識別子であり、ユーザー、開発者、またはプログラムが API に安全にアクセスできるようにします。API キーは API の使用状況を追跡および制御するために不可欠であり、不正使用を防止して、安全な通信を確保するのに役立ちます。

API キーを使用してQlik Cloud API に接続する

API キーを使用して、qlik.dev の REST API リファレンスと対話できます。API アクセスには、Postman や qlik-cli などのツールを使用できます。詳細については、「Qlik API の概要qlik-cli」を参照してください。

例: Postman を使用して Qlik API に接続する

次の手順を実行します。

  1. Postman を起動します。

  2. HTTP メソッドを GET に設定します。

  3. Qlik Cloud API エンドポイントの URL を入力します。

    たとえば、テナント内のすべてのスペースを一覧表示するには、次を実行します。

    https://your-tenant.eu.qlikcloud.com/api/v1/spaces

  4. [認証] タブで、 [認証タイプ] として [ベアラー トークン] を選択します。

  5. [トークン] 項目API キーを入力します。

  6. [送信] をクリックします。

リクエストが成功すると、API は JSON 応答を返します。この例では、応答にスペースのリストが含まれます。

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

既定では、API キーの生成は無効になっています。テナント管理者は、ユーザーが API キーを生成できるように、テナント内で API キーを有効にする必要があります。

次の手順を実行します。

  1. Administration アクティビティ センターで、 [設定] に移動します。
  2. [API キー] で [API キーを有効にする] を選択します。
  3. 必要に応じて、次の設定を調整します。

    • トークンの最大有効期限を変更: 新しく生成されたトークンの有効期限を変更します。既存の API キーは、元の有効期限値を保持します。この値には上限はありません。

    • ユーザーごとのアクティブな API キーの最大数を変更: この制限は新しい API キーにのみ適用されます。制限に達すると、追加の API キーの作成は拒否されます。設定できる最大値は 1000 です。
    情報メモ変更がユーザー プロファイル ページの API キー セクションに反映されることを確認するには、ブラウザを更新する必要がある場合があります。
  4. API キーの生成を開始するには、 [新規生成] をクリックします。ユーザー プロファイルの API キー セクションにリダイレクトされます。

API キーの生成と管理

API キーの生成

新しい API キーを生成するには、開発者ロールが必要です。テナント管理者はユーザーにこのロールを割り当てることができます。

次の手順を実行します。

  1. ユーザー プロファイル アイコンをクリックして、 [プロファイル設定] を選択します。

  2. [API キー] セクションに移動して、 [新規キーの生成] をクリックします。

  3. API キーの説明を入力して、有効期限を設定します。

  4. [生成] をクリックしてキーを作成します。

  5. 生成された API キーをコピーして、安全に保管します。後でキーを取得することはできませんのでご注意ください。

API キーの編集

API キーの名前は、作成後に変更できます。

API キーの削除

情報メモAPI キーの削除は永続的であり、元に戻すことはできません。このアクションにより、キーに依存する進行中のプロセスや統合が中断されないことを確認してください。

次の手順を実行します。

  1. ユーザー プロファイル アイコンをクリックして、 [プロファイル設定] を選択します。

  2. [API キー] セクションに移動します。

  3. 削除する API キーの隣にある 詳細 をクリックし、 [削除] を選択します。

  4. すべてのキーを削除するには、キーのリストの上部にある [すべて削除] をクリックします。

API キーの監視と取り消し

Administration アクティビティ センターの [API キー] セクションで、テナントに関連付けられているすべての API キーを表示できます。名前、ID、または所有者でキーを検索できます。

API キーのステータス

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

  • アクティブ: API キーは現在使用されています。
  • 期限切れ: 有効期限が切れています。
  • 取り消し済み: API キーは取り消されており、使用できなくなります。

API キーの取り消し

テナント管理者として、API キーのアクティビティを積極的に監視することは、セキュリティを維持するために不可欠です。不審なアクティビティが検出された場合は、API キーを取り消すことができます。

情報メモAPI キーを取り消すと、そのキーはすぐに無効化され、そのキーに依存する進行中のプロセスや統合に影響します。取り消しを元に戻すことはできず、取り消された API キーを再度有効にすることはできません。

次の手順を実行します。

  1. Administration アクティビティ センターで、 [イベント] に移動します。

  2. 特定の API キーの過剰な使用など、不審なアクティビティがないか探してください。

  3. イベントの横にある 下向き矢印 をクリックして詳細を展開し、API キー ID をコピーします。

  4. API キー セクションに移動し、その ID を使用して API キーを検索します。

  5. キーの横にある 詳細 をクリックし、[取り消し] を選択します。ステータスがアクティブのキーのみを取り消すことができます。

  6. 複数の API キーを取り消すには、表内で API キーを選択し、右上隅にある [取り消し] をクリックします。

API キー管理のベスト プラクティス

  • キーの機密性を保つ: API キーを安全に保存し、パブリック コード リポジトリに公開されないようにします。

  • 定期的に再生成する: セキュリティを強化するために、API キーを定期的に再生成します。

  • 使用状況を監視する: API キーのアクティビティを定期的にチェックし、不審な動作を特定します。

このページは役に立ちましたか?

このページまたはコンテンツに、タイポ、ステップの省略、技術的エラーなどの問題が見つかった場合は、お知らせください。改善に役立たせていただきます。