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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：3分

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

    始める前に

    必要なロール：admin

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

    手順

    1. 受信認証プロファイルを作成します。
      1. 移動先 すべて > System Web Services > API アクセスポリシー > 受信認証プロファイル.
      2. [新規] を選択します。
        「認証プロファイルの種類は？」というメッセージが表示されます。
      3. [API キー認証プロファイルを作成] を選択します。
        API キー認証プロファイル
      4. フォームのフィールドに入力します。
        表 : 1. API キー認証プロファイル
        フィールド 説明
        名前 認証ポリシーを識別する名前
        アプリケーション 認証ポリシーの範囲
        認証パラメーター 認証要求の認証パラメーターを選択します。デフォルトのオプションを選択するか、新しい認証パラメーターを作成できます。
        • x-sn-apikey：認証ヘッダー
        • x-sn-apikey：クエリパラメーターのヘッダー
        注:
        選択したオプションは、認証ヘッダーまたはクエリパラメーターの一部として REST 呼び出しで定義する必要があります。
        API パラメーター
      5. フォームを送信します。
    2. REST API キーを作成します。
      1. 移動先 すべて > System Web Services > API アクセスポリシー > REST API キー.
      2. [新規] を選択します。
      3. フォームの各フィールドに入力します。
        表 : 2. API キー
        フィールド 説明
        名前 REST API キーを識別するための名前
        説明 REST API キーの説明。
        アクティブ REST API キーのステータス。
        ユーザー REST API キーに関連付けられたユーザー。ルックアップアイコンを使用してユーザーを選択します。
        認証スコープ REST API キーの権限を管理する認証スコープを追加するオプション。
        トークン Now Platform が生成した REST API キー。ヘッダーまたはクエリパラメーター内で REST API コールの一部として使用するキーをコピーします。
        有効期限 認証情報が無効になるまでの時間。空の値は有効期限がないことを意味します。
        注:
        トークンの有効期限の詳細については、「トークンの有効期限のクリーンアップ」を参照してください。
      4. フォームを送信します。
      5. 作成されたレコードを開いて、Now Platform がユーザーのに生成したトークンを表示します。
        API トークン
    3. REST API アクセスポリシーを作成します。
      1. 移動先 すべて > System Web Services > REST API アクセスポリシー.
      2. [新規] を選択します。
      3. フォームのフィールドに入力します。
        表 : 3. 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 認証プロファイルを追加します。
      5. フォームを送信します。
      認証の構成に基づいて、ヘッダーパラメーターまたはクエリパラメーター内で API キーの作成時に Now Platform が生成した x-sn-apikey (トークン) を使用して REST API 呼び出しを送信できます。
      警告:
      サーバーに機密情報を送信する場合は、POST 要求を使用します。