REST API 認証スコープ

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

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

    Xanadu より前のリリースでは、すべてのアクセストークンまたは OIDC トークンが、ユーザーの REST API へのフルアクセス権を持つ useraccount スコープにリンクされています。Xanadu リリース以降では、特定の REST API のみへのアクセスを提供するため、OAuth トークンのスコープが導入されています。

    OAuth エンティティが認証スコープにリンクされている場合、その OAuth エンティティによって発行または管理されるトークンは、REST API へのアクセスにしか使用できません (1 つの OAuth エンティティを複数の認証スコープにリンクすることは可能です)。新しい OAuth エンティティでは、デフォルトの認証スコープは空です。認証スコープを OAuth エンティティに手動でリンクする必要があります。

    注:
    • 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 呼び出しを行う