Skip to main content

APIキーの確認

エージェントまたはカスタムスクリプトとContrastとの通信を確立するには、APIキーを使用します。エージェントおよびContrast APIには、以下の目的でキーが必要になります。

  • アクセスする組織を識別するため

  • 有効なユーザとして識別するため

手順

  1. ユーザメニュー > ユーザの設定 > プロファイルに移動します。

    あなたのキーの下に、APIキーと次のキーを含むAPIキー情報が表示されます。

    • 組織ID:アクセスする組織を識別するものです。

    • サービスキー: 認証情報を使用してContrastサービスに接続するためのものです。

    • 認証ヘッダー: 有効なユーザとして識別するためのものです。

      このキーには、base64(username:service_key)という値が含まれています。

    注記

    組織IDとAPIキーは、組織内の全てのユーザで共通です。サービスキーのみが、各ユーザに固有のものになります。

    Image shows the API keys in User settings > Profile
  2. 認証ヘッダーをコピーするには、コピーを選択します。

  3. サービスキーをローテーションするには、ローテーションをクリックします。

    サービスキーをローテーションすると、このキーを使用しているインテグレーションに影響します。再接続するために、このキーを使用しているインテグレーションで認証情報を更新してください。

  4. サンプルAPIリクエストを生成をクリックすると、サンプルAPIリクエストが生成されてクリップボードにコピーされます。