Modifying an API security resource:

Once an API Security Resource has been defined, it can be modified.

About this task

To modify an API Security Resource:

Procedure

  1. Open the Applications Manager and select the application that you want.
  2. From the tree in the application rules side panel, choose Security > API Security. The API Security Editor window displays.
  3. Expand the APIs or Services branch in Sterling Order Management System.
  4. Select the individual API or Service branch which you want to modify and choose the Details icon. The API Security Resource Details window and API Security Resource Properties window displays.
    API Security Resource Properties window
  5. The API Security Resource Details window displays the various components associated by default with each API Security Resource. If none of the components is selected in the API Security Resource Details window, the API Security Resource Properties window will display the read only information relates to the selected API Security Resource.
  6. Once you select a particular component, the details of that component will appear in the lower property window.
  7. You can configure the following components associated with an API Security Resource:
    Note: When you select Start or End component, the property window This property screen will simply display the default input apisecurity file and output apisecurity file respectively in a text area for quick reference. It cannot be edited, but you can copy the text.

Input filter

About this task

The Input Filter component provides a mean to edit the API filter input XML.

Click the Import Default Filter icon to import the default api filter input XML. Click the Load XML from File icon to load the api filter input XML from a file. Click the Load XML from String icon to load the api filter input XML from string.

To manipulate the Input Filter XML element structure, select the node and click the New Child Element icon to add a new child element in the XML tree, and click the New Attribute icon to add a new attribute for an element in the XML tree.

Select the appropriate attribute of an element whose value you want to set or modify and click the Set Attribute element.

If you want to delete an element or attribute from the XML tree, select the appropriate element or attribute and click the Delete icon.

If you don't want an attribute to be processed during API call. select the appropriate attribute and click the Unselect icon and if you want to change the status of an attribute from Unselect to Select, click the Select icon.

Data security

About this task

The Data Security component allows you to define a list of XPath expressions that identify organizations to validate. Click the Create New icon to add a new XPath expression.

Note: Same configuration will be used for both input as well as output API security.

API

About this task

The API component is used for the API name. It is non-editable.

Output filter

About this task

The Output Filter component is similar to the Input Filter component except it provides a mean to edit the API filter output XML.