Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Create an API authentication policy

Authentication policies allow you to enforce access restrictions on the APIs based on the specified filter criteria.

Before you begin

Role required: api_service_admin, adaptive_auth_policy_admin

Procedure

  1. Navigate to All > System Web Services > API Authentication Policy.

  2. Click New.

  3. On the form, fill in these fields.

    FieldDescription
    NameName to identify the policy.
    DescriptionShort description of the policy.
    ApplicationScope of the application.
  4. Right-click the form header and select Save.

  5. From the Policy Inputs tab, select Edit to add the existing Filter Criteria.

    You can also create a new Policy Input. For more information, see Create policy inputs.

  6. Move one or more filter criteria from the Collections list to the Policy Inputs List.

Image omitted: authentication-filter-criteria.png
Adding one or more filter criteria to an authentication policy.
  1. Select Save.

  2. From the Policy Conditions tab, select New.

  3. On the form, fill in these fields.

    FieldDescription
    LabelName of the policy condition.
    DescriptionShort description of the policy condition.
    ApplicationScope of the application.
    ConditionOne or more conditions that are combined with OR filter.
Image omitted: policy-conditions-authentication.png
Example policy condition with multiple criteria.
  1. Select Submit.