RESTful API - Getting started

The OpenIAM solution architecture provides an extensive REST API which is used by the UI layer. This REST API can be used to provide for a deeper integration between OpenIAM and your applications or to extend OpenIAM to solve new problems. This section describes how you can get started with the API.

These steps below will use Postman, a popular API testing tool, to describe the integration process. These same steps should be applied to your application.

The Full REST API documentation can be found in each OpenIAM deployment by going to: Webconsole > Adminstration > REST API Documentation. These docs are provided through Swagger to allow for an interactive experience.

To use the REST API from Postman, you will need to follow the following high-level steps: