Previous Topic: CA ControlMinder REST APINext Topic: HTTP Verbs


REST-based API

REST (Representational State Transfer) describes an architectural style characteristic of software that relies on the inherent properties of hypermedia to create and modify the state of an object that is accessible at a URL.

In a RESTful scenario, documents (representing the state of an object) are passed back and forth between a client and a service with the assumption that neither knows anything about any entity other than what is in a single request or response.

To get the schema for the REST-based API, navigate to the following URL and View the source of the empty page:

https://hostname:18443/iam/api/1.0/restapi/schemas

Note: For more information about the schema, see the examples in this section.

You can use the REST requests to communicate between your custom, or third-party programs with the SAM database by-passing the Enterprise Management Server User Interface.