Create REST API access policy

task australia Updated Sep 10, 2026 2 min read create-api-access-policy.md
Raw file servicenow.com

Create an API access policy and map an authentication profile to restrict the authentication type for a REST API. For example, you can create an API access policy that allows only ID token authentication for a REST API.

Before you begin

An authentication profile must be created. For more information, see Create an authentication profile.

Role required: api_service_admin, adaptive_auth_policy_admin

Procedure

  1. Navigate to All > System Web Services > REST API Access Policies.

  2. Select New.

  3. On the form, fill in the required fields and submit.

    [Omitted image "rest-api-access-policy.png"] Alt text: API access policy fields

    Note: You must reopen the submitted form to populate additional fields.

Field

Description

Name

Unique name of the API access policy.

Active

Option to make the API access policy active.

REST API

The REST API to which the access policy is applied. For example, Attachment API.

REST API PATH

API path of the REST API. This field is auto-populated based on the selected REST API. For example, now/attachment.

HTTP Method

Method used for interacting with the API. This field is auto-populated based on the selected REST API.

Version

Version of the API. For example, v1. This field is auto-populated based on the selected REST API.Note: To create an authentication policy for all versions of a REST API, you must create individual policies for each version.

Resource

Child resource of the REST API. This field is auto-populated based on the selected REST API. For example, /now/attachment

Table

The tables to which the API access policy applies. This option only applies to policies for the Table API.

Application

Scope of the application.

Global

Option to apply the policy to all methods, versions, and resources for the API.

Apply to all methods

Option to apply the policy to all the methods, versions, and resources for the API.

Apply to all resources

Option to apply the policy to all or some of the API resources.

Apply to all versions

Option to apply the policy to all or some of the API versions.

Apply to all tables

Option to apply the policy to all tables. This option only applies to policies for the Table API.

Advertise all auth schemes

Setting that determines whether the WWW-Authenticate header includes all configured authentication schemes. When set to false (default), the header includes only the most recently configured authentication profile in the policy. When set to true, the header lists all configured authentication schemes.

**Note:** To understand more about the API access policy prioritization, see [API access policy prioritization](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-security/authentication/api-access-policy-prioritization.md).
  1. Double-click Insert a new row.

  2. Select an inbound authentication profile from the list and select the save icon [Omitted image "green-checkmark.png"] Alt text: save icon.

    For example, you can add Basic Auth, ID Token, Certificate based Auth, OAuth or WSSE Auth.

    1. To add one or more inbound authentication profiles, select New to create a new profile.

    2. Choose What Kind of authentication profiles?.

      • Create standard http authentication profiles
      • Create WSSE authentication profiles
      • Create API Key authentication profiles
      • Create HMAC authentication profiles [Omitted image "auth-profile.png"] Alt text: Authentication profile
    3. After creating the authentication profile, save the record.

  3. Select Submit to submit the REST API access policy.

Search documentation
Search document titles and file paths on the australia branch