2 Getting Started

The Oracle Life Sciences IAMS Inbound User Provisioning Service API is a web services interface into Oracle Life Sciences IAMS. It is an HTTP-based API that is technology and platform independent.

• Requirements for working with the API
  To use the Oracle Life Sciences IAMS Inbound User Provisioning Service API, the client must be able to issue HTTP GET, POST, PUT, PATCH, and DELETE calls.
• User Capabilities
  The user specified in the call to the API must have appropriate Oracle Identity Manager roles to perform the administration operations.
• Stateless API
  The Oracle Life Sciences IAMS 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.
• Encryption
  All communication with the Oracle Life Sciences IAMS Inbound User Provisioning Service API is encrypted and secured using HTTPS connections.
• Authentication
  The Oracle Life Sciences IAMS 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).
• Terminology
  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 RFC 2119.
• Detailed API Specifications
  The following chapters describe the Oracle Life Sciences IAMS Inbound User Provisioning Service API, grouped by Oracle Life Sciences IAMS resources. In the URLs shown, values within braces {} are meant to be placeholders for the ID of a specific instance of the resource.