Create a new Resource

Edit online

To create a new Resource with the local management interface, use the API Access Control resources page.

Procedure

  1. In the appliance top menu, Web > API Access Control > Resources.
  2. The user is prompted to set the user name, password, and domain for the Policy Server if these credentials are not already set.
    See Storing the IBM Verify Identity Access operations for managing Access Control Policies.
  3. Expand the Reverse Proxy instance to show the list of available resource servers.
    These are the 2nd level objects in the tree.
  4. Select the required resource server to create the Resource.
  5. Click Add.
    A dialog box is displayed prompting for the resource server details.
  6. In the Identification tab, enter the details for the new API resource.
    1. Enter the user friendly description for this resource in the Name field.
    2. Enter the path for this resource in the Path field.
    3. Select the HTTP method for this resource from the Method drop-down list.
    4. Add any path aliases that can be used for this resource to the list of URL aliases.
      1. Click Add. A dialog is displayed prompting for the new alias.
      2. Enter the new alias.
        Note: A wildcard character (*) might be used if required.
      3. Click Save.
    5. Remove any path aliases by selecting the alias or aliases in the list and click the Delete button.
  7. In the Policy tab, select the policy to be attached to this resource
    1. Use the parent policy and select the default Verify Identity Access Policy radio button. Do not attach any policy directly. This will use the policy set in the resource server.
    2. Click the No Access Permitted (disabled) radio button to not allow access.
    3. Click the Unauthenticated Access Allowed radio button to allow unauthenticated access.
    4. Click the Any Authenticated radio button to allow any authenticated access.
    5. Click the Custom radio button to use a custom Access Control Policy.
    6. Select the custom policy name form the drop-down list.
    7. Select the rate limiting policy to be attached to this resource by using the Rate Limiting Policy dropdown.
    8. Select the CORS policy to be attached to this resource by using the CORS Policy dropdown.
  8. In the Responses tab, set any static response headers to create.
    1. Click Add to add a new response header.
      1. In the dialog box, select the Header Name or enter a new value in the Header Name field.
      2. Enter the Header Value.
      3. Click Save.
    2. To delete a response header select the header from the list and click Delete.
  9. In the Documentation tab, enter the settings to allow the resource documentation to be returned.
    1. Enter the content type that can be used to retrieve the documentation. For example, application/swagger.json. If a request to the resource contains this value in the accept header, the documentation file is returned.
    2. Select the documentation file from the drop-down list. If it does not exist click the upload button to select and upload the file. These files can be managed by using Manage the API documentation root.
  10. Once all of the data are set, click Save to create the new resource.

What to do next

To view a list of the operations that are run to create a new resource, see the api_access_control.log as described in Auditing the Verify Identity Access operations that are performed when managing API Access Control components.