DataPower API Gateway only

Authoring policies for the DataPower API Gateway

A user-defined policy for the DataPower® API Gateway consists of a package containing configuration details that define the actions of the policy. You publish the package to the DataPower® API Gateway to make it available to APIs that are deployed there.

There are two types of user-defined policies, Catalog scoped user-defined policies and global scoped user-defined policies:

Catalog-scoped user-defined policies
Catalog-scoped user-defined policies are available to APIs only in the Catalogs that you specify. Use a Catalog scoped user-defined policy if you want to limit the availability of your policy on a Catalog specific basis. The possible actions of a Catalog scoped user-defined policy are limited to the API Connect built-in assembly policies. For more information, see Defining, packaging, and publishing a catalog-scoped policy for the API Gateway.
Global-scoped user-defined policies
Global-scoped user-defined policies are available to APIs in every Catalog in every provider organization. Use a global scoped user-defined policy in the following situations:
  • You want to make your policy available everywhere rather than limiting its availability to specific Catalogs.
  • Your policy uses a DataPower® implementation, where configuration changes are made directly on the DataPower API Gateway.
Note: Global-scoped user-defined policies are not the same as global policies that you define with the toolkit CLI, as documented on Working with global policies.
For more information, see Defining, packaging, and publishing a global-scoped policy for the API Gateway.