HMAC の構成 - トークンベースの認証

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：5分

    • REST API エンドポイントの認証をサポートするように HMAC を設定します。

    始める前に

    必要なロール：admin

    必要なプラグイン：API キーと HMAC 認証 (com.glide.tokenbased_auth)

    手順

    1. HMAC 構成を作成します。
      1. 移動先 すべて > システム Web サービス > API アクセスポリシー > HMAC 構成.
      2. [New (新規)] を選択します。
        注:
        プラグインのインストール時に作成されるデフォルトの HMAC SHA256 Base64 エンコーディングを使用することもできます。
      3. フォームの各フィールドに入力します。
        表 : 1. HMAC 構成
        フィールド 説明
        名前 HMAC 構成の名前。
        アプリケーション 構成のスコープ。
        説明 構成に関する詳細な説明。
        ハッシュアルゴリズム ハッシュアルゴリズムを選択します。利用可能なオプション：
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512
        HMAC ユーティリティスクリプト HMAC のユーティリティスクリプト。
        注:
        キー ID なしで要求本文、タイムスタンプ、およびシークレットを使用して HMAC 認証を検証する場合は、次の手順を実行します。
        • カスタマイズされたスクリプトインクルードを HMAC ユーティリティスクリプトとして作成します。
        • そのスクリプトインクルードユーティリティを使用して、渡されたタイムスタンプと要求本文を解釈します。

        ServiceNow® インスタンスで作成された共有シークレットごとに、キー ID があります。HMAC 認証プロファイルのデフォルトキー ID に、そのキー ID を構成する必要があります。
        HMAC 構成
      4. レコードを送信します。
    2. 受信認証プロファイルを作成します。
      1. 移動先 すべて > システム Web サービス > API アクセスポリシー > 受信認証プロファイル.
      2. [New (新規)] を選択します。
        「認証プロファイルの種類は？」というメッセージが表示されます。
      3. [HMAC 認証プロファイルを作成] を選択します。
        HMAC 認証プロファイル
      4. フォームのフィールドに入力します。
        表 : 2. HMAC 認証プロファイル
        フィールド 説明
        名前 認証ポリシーを識別する名前
        アプリケーション 認証ポリシーの範囲
        HMAC の構成 作成された HMAC 構成を選択します。
        認証パラメーター 認証要求の認証パラメーターを選択します。デフォルトのオプションを選択するか、新しい認証パラメーターを作成できます。
        • x-sn-hmac-signature-256：認証ヘッダー
        • x-sn-hmac-signature-256：クエリパラメーター
        共有シークレットのデフォルトキー ID HMAC を使用するためにこのフィールドで更新できるトークン情報。
        注:
        選択したオプションは、認証ヘッダーまたはクエリパラメーターの一部として REST 呼び出しで定義する必要があります。HMAC プロファイル
      5. フォームを送信します。
    3. HMAC シークレットを作成します。
      1. 移動先 すべて > システム Web サービス > API アクセスポリシー > REST API HMAC シークレット.
      2. [New (新規)] を選択します。
      3. フォームの各フィールドに入力します。
        表 : 3. REST API HMAC シークレット
        フィールド 説明
        名前 REST API HMAC シークレットを識別するための名前
        説明 REST API HMAC シークレットの説明。
        アクティブ REST API HMAC シークレットのステータス。
        ユーザー REST API HMAC シークレットに関連付けられたユーザー。ルックアップアイコンを使用してユーザーを選択します。
        キー ID REST 呼び出しの一部として送信する必要があるキー ID。キー ID はフォームの送信後に生成されます。
        共有シークレット ユーザーの共有シークレット。パスワードなどです。
        ソース レコードのソース。
        有効期限 認証情報が無効になるまでの時間。空の値は有効期限がないことを意味します。
        注:
        トークンの有効期限の詳細については、「トークンの有効期限のクリーンアップ」を参照してください。
      4. フォームを送信します。
      5. 作成されたレコードを開きます。

        ServiceNow AI Platform がユーザーに生成したキー ID を検索します。

        HMAC キー ID
        注:
        API 呼び出しの認証パラメーターまたはクエリパラメーターを指定しない場合は、HMAC 用に作成された認証プロファイルのキー ID 時に生成されたキー ID を追加できます。
    4. REST API アクセスポリシーを作成します。
      1. 移動先 すべて > システム Web サービス > REST API アクセスポリシー.
      2. [New (新規)] を選択します。
      3. フォームのフィールドに入力します。
        表 : 4. API アクセスポリシー
        フィールド 説明
        名前 API アクセスポリシーの一意の名前。
        有効 API アクセスポリシーをアクティブにするオプション
        REST API アクセスポリシーが適用される REST API。例：添付ファイル API
        REST API パス REST API の API パス。このフィールドは、選択した REST API に基づいて自動入力されます。たとえば、now/attachment です。
        HTTP メソッド API とのやり取りに使用されるメソッド。このフィールドは、選択した REST API に基づいて自動入力されます。
        バージョン API のバージョン。- 例：v1。このフィールドは、選択した REST API に基づいて自動入力されます。
        注:
        REST API のすべてのバージョンに対して認証ポリシーを作成する場合は、バージョンごとに個別のポリシーを作成する必要があります。
        リソース REST API の子リソース。このフィールドは、選択した REST API に基づいて自動入力されます。例：/now/attachment
        アプリケーション アプリケーションのスコープ。
        グローバル このフィールドを有効にして、API のすべてのメソッド、バージョン、およびリソースに認証ポリシーを適用可能にします。
        注:
        グローバル REST API ポリシーではトークンベースの認証は許可されていません。
        すべてのメソッドに適用 このフィールドを有効にして、API のすべてのメソッド、バージョン、およびリソースに API の認証ポリシーを適用可能にします。
        すべてのリソースに適用 このフィールドを有効にして、すべてのバージョンに API の認証ポリシーを適用可能にします。
        すべてのバージョンに適用 このフィールドを有効にして、すべてのリソースに API の認証ポリシーを適用可能にします。
      4. 作成された API 認証プロファイルを追加します。
        HMAC プロファイルをアクセスポリシーに追加
      5. フォームを送信します。
        次の方法で REST API 呼び出しを送信できます。
        • 認証の構成に基づいて、ヘッダーパラメーターまたはクエリパラメーター内で API キーの作成時に ServiceNow® が生成した x-sn-hmac-signature-256 を使用します。
        • 共有シークレットが要求の一部として指定された事前要求スクリプトを使用します。
        警告:
        サーバーに機密情報を送信する場合は、POST 要求を使用します。