---
sourceDocument: Xanadu IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/it-operations-management

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# MID Web サーバー API キー認証を構成する

# MID Web サーバー API キー認証を構成する {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：2分

API キー認証を使用して、クライアントから MID Web サーバー 拡張への着信要求を認証します。API 認証は、要求を認証するための安全で簡単な方法です。MID Web サーバー API キーを作成または変更できます。

## 始める前に

[MID Web サーバー 拡張の設定](https://servicenow-prod.fluidtopics.net/Apooo0iziQzXHh6kOp4pnA "MID Web サーバー は、イベントとメトリクスを MID サーバー に送信する REST API の開発を可能にする MID サーバー 拡張です。この拡張は、メトリックインテリジェンス や MID Web サービスイベントリスナー、エージェントクライアントコレクター Websocket エンドポイント拡張といった他の MID サーバー 拡張によって活用されます。") の説明に従って、API キー認証を使用する MID Web サーバー 拡張を作成します。拡張の \[認証タイプ\] フィールドで \[API キー\] を選択していることを確認してください。

必要なロール：event_mgmt_admin

## このタスクについて

デフォルトでは、1 つのインスタンスに作成できる API キーの最大数は 10 です。この数を変更するには、\[システムのプロパティ\] ページの mid.webserver.max.api.keys プロパティ値を変更します。

\[ドメインセパレーション\] が有効なときにグローバルドメインで作業している場合、API キーはドメインに関係なくすべての拡張で使用できます。特定のドメインで作業している場合は、そのドメイン、その親ドメイン、、およびグローバルドメインの拡張に対して API キーを使用できます。

指定した日付に期限切れになるように API キーを設定できます。

API キー認証を使用して新しい拡張を作成する (または API キー認証を使用するように既存の拡張を更新する) と、システムは拡張に利用可能な API キーを確認します。利用可能な API キーがない場合は、API キーを作成します。

## 手順

1. 移動先 すべてMID サーバープロファイルと展開MID Web サーバー API キー.
2. 新しい API キーを作成するか、既存の API キーを変更します。  
   * 新しい API キーを作成するには、次の手順に従います。
     1. \[新規\] を選択します。
     2. \[MID Web サーバー API キー\] フォームのフィールドに入力します。{#mid-web-server-api-key-authentication__table_bn5_25k_lrb__entry__2}

        | フィールド | 説明 |
        |-|-|
        | 名前 | API キーの名前。 |
        | 有効 | API キーを有効にするためのオプション。 |
        | 認証キー | 認証キーの、読み取り専用のエンコード値。キーを設定するまで値は表示されません。 |
        | 有効期限 | API キーの有効期限を設定するためのオプション。 期限切れ、非アクティブ化、または削除された API キーは、Web サーバー拡張では受け入れられません。 |
        [表 : 1. MID Web サーバー の \[API キー\] フォーム]

        {#mid-web-server-api-key-authentication__table_bn5_25k_lrb}
     3. \[送信\] を選択して API キーを保存します。

        API キーが \[MID Web サーバー API キー\] ページに表示されます。
     {#mid-web-server-api-key-authentication__ol_otp_hrt_1sb}
   * 既存の API キーを変更するには、次の手順に従います。
     1. 移動先 MID サーバープロファイルと展開MID Web サーバー API キー.
     2. ページで API キーを選択します。
     3. \[関連リンク\] セクションで、\[API キーを表示\] を選択します。
     4. \[MID Web サーバー\] ダイアログボックスに表示される API キーをコピーします。API キー認証で構成された MID Web サーバー 拡張に接続する際は、その拡張がアクセスできる API キーを、次の形式で要求の \[認証\] ヘッダーに配置します。

        `キー <API_KEY>`
        ここで `<API_KEY>` は、\[API キーを表示\] を選択した後に表示される API キーの値です。
     5. \[送信\] を選択します。
     {#mid-web-server-api-key-authentication__ol_i25_tst_1sb}
   {#mid-web-server-api-key-authentication__ul_esg_grt_1sb}