Create an API authentication policy

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read
  • Authentication policies allow you to enforce access restrictions on the APIs based on the specified filter criteria.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > System Web Services > API Authentication Policy.
    2. Click New.
    3. On the form, fill in these fields.
      Table 1. Policy form
      Field Description
      Name Name to identify the policy.
      Description Short description of the policy.
      Application Scope 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.Adding one or more filter criteria to an authentication policy.
    7. Select Save.
    8. From the Policy Conditions tab, select New.
    9. On the form, fill in these fields.
      Table 2. Condition form
      Field Description
      Label Name of the policy condition.
      Description Short description of the policy condition.
      Application Scope of the application.
      Condition One or more conditions that are combined with OR filter.
      Example policy condition with multiple criteria.
    10. Select Submit.