IBM API Hub
IBM OpenPages REST API V2

By IBM OpenPages

The IBM® OpenPages® GRC REST API provides access to IBM OpenPages® data and metadata. This data-centric API is specified in terms of resources, their URIs, and actions that can be performed on these URIs.


This topic describes how to begin using the IBM® OpenPages® GRC REST API, including what URIs to use and what support is included for SCIM.

For more information about the IBM® OpenPages® GRC REST API V2 including security and authentication, performance, and client/server interactions, see IBM OpenPages GRC REST API V2.

URI design

In the IBM® OpenPages® model, the metadata it defines, and their corresponding data can be accessed, updated, and created using the REST API. The REST API takes the form of URIs for these resources. The complete set of supported actions, their paths, parameters, and corresponding returned codes are defined. Data sent and returned during these HTTP interactions can either be in the HTTP body or as attachments.

The specification of the URI address and the naming of path segments is not arbitrary. Every URI begins with https://{server_name}/{basePath}.

OpenPages® on Cloud Pak for Data

On OpenPages® on Cloud Pak for Data, {server_name} is the URL of Cloud Pak for Data and {basePath} is openpages-<instance_name>-opgrc/api where <instance_name> is the name of the OpenPages instance.

For example, you can use the following URI paths for IBM® OpenPages® GRC REST API V2 where {server_name} is cpd-example.com and {basePath} is openpages-openpagesinstance1-opgrc/api:

  • https://cpd-example.com/openpages-openpagesinstance1-opgrc/api/v2
  • https://cpd-example.com/openpages-openpagesinstance1-opgrc/api/v2/types
  • https://cpd-example.com/openpages-openpagesinstance1-opgrc/api/v2/scim/Users

IBM® OpenPages® and OpenPages® on Cloud

On IBM® OpenPages® and OpenPages® on Cloud, {server_name} is the host and port for the URI and {basePath} is /opgrc/api.

For example, you can use the following URI paths for IBM® OpenPages® GRC REST API V2 where {server_name} is example.com:8888 and {basePath} is opgrc/api:

  • https://example.com:8888/opgrc/api/v2
  • https://example.com:8888/opgrc/api/v2/types
  • https://example.com:8888/opgrc/api/v2/scim/Users

Support for SCIM

The endpoints for Groups, ResourceTypes, Schema, ServiceProviderConfig, and Users are based on the SCIM 2.0 specification. Note that the SCIM ETags feature is not supported. If a request to an SCIM endpoint contains invalid data, the server will respond with a 400 Bad Request response.

For more information about SCIM, see System for Cross-domain Identity Management: Protocol.

Open API Specification

About specification
API Version

9.0.0.5

Legend
Technologies
Products & Services
Architectures & Deployment models
Company information
Company logoIBM OpenPages