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

Procedure

  1. Navigate to All > System Web Services > REST API Access Policies.
  2. Click New.
  3. On the form, fill in the fields.
    API access policy fields
    Table 1. API Access Policies
    FieldDescription
    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: If you want 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
    Application Scope of the application.
    Global Enable to apply auth policy to all methods, versions, and resources for the API.
    Apply to all methods Enable to apply auth policy for the API to all the methods, versions, and resources for the API.
    Apply to all resources Enable to apply auth policy for the API to all the versions.
    Apply to all versions Enable to apply auth policy for the API to all the resources.
    Note: To understand more about the API access policy prioritization, see API access policy prioritization.
  4. Double-click Insert a new row.
  5. Select an inbound authentication profile from the list and click the save icon 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, click New to create a new profile.
    2. Choose What Kind of authentication profiles?.
      • Create standard http authentication profiles
      • Create WSSE authentication profiles
      Authentication profile
    3. After creating the authentication profile, save the record.
  6. Click Submit to submit the REST API access policy.