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

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分

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

    始める前に

    必要なロール：admin

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

    手順

    1. HMAC 構成を作成します。
      1. 移動先 すべて > システム Web サービス > API アクセスポリシー > HMAC 構成.
      2. [新規] を選択します。
        注:
        プラグインのインストール時に作成される デフォルトの HMAC SHA256 Base64 エンコーディング を使用することもできます。
      3. フォームの各フィールドに入力します。
        表 : 1. HMAC 構成
        フィールド 説明
        名前 HMAC 構成の名前。
        アプリケーション 構成のスコープ。
        説明 構成に関する詳細な説明。
        ハッシュアルゴリズム ハッシュ アルゴリズムを選択します。利用可能なオプション:
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512
        HMAC ユーティリティスクリプト HMAC のユーティリティスクリプト。
        HMAC 構成
      4. レコードを送信します。
    2. 受信認証プロファイルを作成します。
      1. 移動先 すべて > システム Web サービス > API アクセスポリシー > 受信認証プロファイル.
      2. [新規] を選択します。
        「認証プロファイルの種類は？」というメッセージが表示されます。
      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. [新規] を選択します。
      3. フォームの各フィールドに入力します。
        表 : 3. REST API HMAC シークレット
        フィールド 説明
        名前 REST API HMAC シークレットを識別するための名前。
        説明 REST API HMAC シークレットの説明。
        アクティブ REST API HMAC シークレットのステータス。
        ユーザー REST API HMAC シークレットに関連付けられているユーザー。検索アイコンを使用してユーザーを選択します。
        キー ID REST 呼び出しの一部として送信する必要があるキー ID。キー ID はフォームの送信後に生成されます。
        共有シークレット ユーザーの共有シークレット。たとえば、パスワードです。
        ソース レコードのソース。
      4. フォームを送信します。
      5. 作成されたレコードを開きます。

        ユーザーに対して生成された Now Platform キー ID を検索します

        。HMAC キー ID
        注:
        API 呼び出しの認証パラメーターまたはクエリパラメーターを指定しない場合は、HMAC 用に作成された認証プロファイルのキー ID 中に生成されたキー ID を追加できます。
    4. REST API アクセスポリシーを作成します。
      1. 移動先 すべて > システム Web サービス > REST API アクセスポリシー.
      2. [新規] を選択します。
      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 キー作成中に生成された x-sn-hmac-signature-256 ServiceNow® を使用します。
        • 共有シークレットが要求の一部として指定された事前要求スクリプトあり。
        警告:
        サーバーに機密情報を送信する場合は、 POST 要求を使用します。