Read API access

You can use the Read API Access filter to get information from the client registry about a particular organization's, or a particular application's, access to an API.

This filter stores the information in a message attribute (for example, apimgmt.apiaccess). You can use this filter within an alert handling policy (or any other policy) to read an organization's or an application's API access easily.

General settings

Configure the following fields:

Name:

Enter an appropriate name for the filter.

API ID selector:

Enter a selector expression with the name of the message attribute that contains the API ID. The value of the selector is expanded at runtime. The default is ${apimgmt.apiproxy.id}.

Entity ID selector:

Enter a selector expression with the name of the message attribute that contains the application or organization entity ID. The value of the selector is expanded at runtime. The default is ${apimgmt.entity.id}.

Type:

Choose the type of the entity, Application or Organization.

Name of attribute to set:

Enter the name of the message attribute to set. The default is apimgmt.apiaccess.

Further information

For more details on configuring policies, see the API Gateway Policy Developer Guide.

Related Links