Applying a policy template to an API

Edit online

To customize the policy configurations for an API by using a policy template, you must apply the template that contains a set of policies. After you apply the template, configure the properties of the individual policies to suit the runtime requirements for that API.

Before you begin

You must have the Manage policy templates functional privilege to perform the task.

About this task

The Policies tab on the API details page specifies the set of policies that webMethods API Gateway runs when an application requests access to that particular API.

The API can have a set of policies that are applied through a global policy, a policy template, scope-level policy, and API-level policy.

Procedure

  1. Open the menu options and select APIs.
    A list of all registered APIs appears.
  2. Select the required API.
  3. Click Edit.
    Note: If the API is active when you modify API, webMethods API Gateway displays a warning message, which indicates that the API is active.
  4. Click Policies.
    The API's policy information is provided in the Policy catalog, Infographic, and Policy properties.
  5. To apply a policy template perform the following steps.
    1. Click Apply template. The Apply template dialog box appears.
    2. Select one or more policy templates that you want to apply to the API in the Template chooser. You can choose to display the details of an individual policy template by clicking the Info icon. You can see the list of policies that are defined in the particular template.

    3. Select one or more policy templates that you want webMethods API Gateway to run at run time.

    4. Click Next. Select at least one template to use the Next button.
    5. In the Apply Templates to API wizard, review the list of policies and the configuration details of the associated policies. Click Previous to return to the Template chooser wizard and change your template selections. Click Cancel if you want to abandon all your changes and return to the Policies tab.
    6. Click Apply. If you have one or more policy conflicts, webMethods API Gateway displays the conflicting and incompatible policies with a Conflict icon. You can choose to resolve the policy conflicts and click Apply, or you can continue to Apply with conflicts. If you choose to continue with conflicts, webMethods API Gateway sets the focus on the conflicting policies. A Conflict icon displays next to the policy names in the Infographic section and the corresponding policy stages. webMethods API Gateway redirects you to the Policies tab. The newly applied policy template that comprises a set of policies and the policy properties is displayed in the Infographic section.
    7. Click Save to save the updated API.

What to do next

Activate the API when you are ready to put the policy template into effect.