REST API limitations for IBM Verify Identity Governance

Edit online

Some information about the IBM Verify Identity Governance REST APIs might not be available in the IBM Verify Identity Governance Knowledge Center for Version 7.0.0.2.

Use the information about the REST APIs as an addendum to the information that is available in the IBM Verify Identity Governance Knowledge Center.
  • IBM Verify Identity Governance REST API documentation can be best viewed in the supported versions of the Mozilla Firefox and Microsoft Internet Explorer browsers.
  • You can configure cross-origin resource sharing (CORS) to control which origins can work with the IBM Verify Identity Governance REST APIs. For more information about CORS configuration, see Starting REST APIs in a domain different from the originating web page.
To support CORS in the virtual appliance, do these steps.
  1. Log on to the IBM Verify Identity Governance - Virtual Appliance console.
  2. From the top-level menu of the Appliance Dashboard, select Configure > Advanced Configuration > Update Property to display the Update Property page.
  3. In the Update Property page, select All properties.
  4. Select Identity server property files.
  5. Select rest.properties.
  6. Click New to open the Add Property window.
  7. Provide the value in the Property name field as ui.CORSOrigin.
  8. Provide the value in the Property value field to one of the following values.
    • *
    • For example, http://www.ibm.com
      Note: You can also add a port number with the domain name when you provide a property value. Use white spaces to separate multiple property values.
  9. Click Save Configuration.
After you edit the ui.CORSOrigin property, restart the Verify Identity Governance Server to reflect the changes. Do these steps.
  1. From the Appliance Dashboard, go to the Server Control widget.
  2. Select Security Identity Manager server.
  3. Click Restart.

If you do not want to allow cross domain request to access IVIG Service Center REST APIs, do not configure the ui.CORSOrigin property in the virtual appliance.

If you already configured rest.properties with the ui.CORSOrigin property, delete the ui.CORSOrigin property. Do these steps.

  1. Log on to the IBM Verify Identity Governance - Virtual Appliance console.
  2. From the top-level menu of the Appliance Dashboard, select Configure > Advanced Configuration > Update Property to display the Update Property page.
  3. In the Update Property page, select Modified properties.
  4. Select Identity server.
  5. Select rest.properties.
  6. Click Delete.
  7. Click Yes to confirm.
  • REST APIs are one of the new functions in the IBM Verify Identity Governance 7.0.0.2 release. The What's new in this release section of the IBM Verify Identity Governance Knowledge Center for Version 7.0.0.2 does not contain information about REST APIs. However, the REST API information is available at REST APIs.
  • The path that is described for the REST API code samples in the IBM Verify Identity Governance Knowledge Center for Version 7.0.0.2 requires a change. The REST API code samples are available at extensions/7.0/examples/restapi.

    On the Custom File Management page of the Appliance Dashboard, go to directories/utilities and download the extensions.zip file.

  • As described in the previous bullet, the REST API code samples are available at extensions/7.0/examples/restapi. To know more about how to authenticate to the Verify Identity Governance Server and then start a specific REST API, see extensions/7.0/examples/restapi/examples/api/SearchPeople.java.
  • Filter configuration for REST services is possible by using the supported operators. For more information, see Filter configuration for REST search services. However, the definitions of the supported operators are not described in the IBM Verify Identity Governance Knowledge Center topic for Version 7.0.0.2. You can use the following definitions for the supported operators to configure the filter expressions for the REST services.
    Table 1. Supported operators
    Logical operators Comparison operators
    and - & Equal - =
    or - | Not equal - !=
      Approximately equal - ~=
      Greater than or equal - >=
      Less than or equal - <=
      Greater than - >
      Less than - <
  • IBM Verify Identity Governance - Virtual Appliance contains an OAuth provider. Therefore, you need not configure OAuth separately for the virtual appliance.