The OHSIAMS Inbound User Provisioning Service API is a web services interface into the OHSIAMS application. It is an HTTP-based API that is technology and platform independent.
To use the OHSIAMS Inbound User Provisioning Service API, the client must be able to issue HTTP GET, POST, PUT, PATCH, and DELETE calls.
The user specified in the call to the API must have appropriate OIM roles to perform the administration operations.
The OHSIAMS Inbound User Provisioning Service API that the application exposes is stateless. This means that each call is independent of the previous call, and the information conveyed by the client in the request must be sufficient for the server to understand and act on the request.
All communication with the OHSIAMS Inbound User Provisioning Service API is encrypted and secured using HTTPS connections.
The OHSIAMS Inbound User Provisioning Service API is protected by the Basic Authentication scheme. Basic authentication headers must be part of each request. The username must be tenant-qualified (<tenant>.username).
The keywords must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this document are to be interpreted as described in RF C 2119.
The following chapters describe the OHSIAMS Inbound User Provisioning Service API, grouped by OHSIAMS resources. In the URLs shown, values within braces {} are meant to be placeholders for the ID of a specific instance of the resource.
Each OHSIAMS API specification includes the following information:
Purpose
HTTP request method: GET, DELETE, PATCH, POST, PUT
URL: the URL to which the call is made
Request schema URI
Response schema URI
HTTP response codes
Sample output in JSON.