REST API 認証スコープ

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：2分

    • REST API の認証スコープのサポート。

    以前は、すべてのアクセストークンまたは OIDC トークンが、ユーザーの REST API へのフルアクセス権を持つ ユーザーアカウント スコープにリンクされていました。Yokohama リリースから、特定の REST API にのみアクセスできるようにするために、REST API 認証スコープが導入されました。

    REST API 認証スコープレコードを作成した後、この REST API にアクセスするには、この REST API にアクセスできる必要がある OAuth エンティティに同じ認証スコープを関連付ける必要があります。新しい OAuth エンティティの場合、デフォルトの認証スコープは空です。

    注:
    REST API 認証スコープレコードがない限り、有効な OAuth エンティティであれば REST API にアクセスできます。

    OAuth エンティティ内の認証スコープを手動でリンクする必要があります。ユーザーアカウントは特別なスコープです。OAuth エンティティに関連付けられている場合、別の認証スコープで REST API 認証スコープレコードを作成していても、任意の API にアクセスできます。

    注:
    • REST API 認証スコープが有効になって REST API の認証スコープに追加された後は、アドミニストレーターがこの認証スコープを対応する OAuth エンティティに追加しない限り、既存のすべての OAuth トークンがこの API にアクセスできなくなります
    • アドミニストレーターは、認証スコープを REST API にリンクした後に、oauth_entityに適切な認証スコープがあることを確認する責任があります。
    • ServiceNow によって発行された OAuth アクセストークンは認証スコープをサポートします。
    • ServiceNow によって発行されていない OIDC トークンは ServiceNow によって検証されます。
    • ID トークンが必要な場合、OIDC トークンには IDP からのスコープがあります。ここでは、認証スコープはサードパーティ (IdP) 用ではなく ServiceNow 用です。

    REST API スコープの設定

    REST API スコープを設定するには、次のタスクを実行します。
    • 認証スコープを作成する
    • 認証スコープを REST API にリンクする
    • 認証スコープを OAuth エンティティにリンクする
    • OAuth フローを実行して OAuth アクセストークンを取得する
    • OAuth アクセストークンを使用して API 呼び出しを行う