API
1. RESTful API
Access Control offers increased control and flexibility through the support of a RESTful (Representational State Transfer) API for accessing a set of resources through a fixed set of operations.
1.1 Prerequisites
Provided examples use Curl on the command line, but many other delivery mechanisms can achieve the same thing against a Restful API will.
1.2 Authentication
Provided examples show the use of admin:password credentials for clarity. Clearly you shouldn't use this approach for production. It can be beneficial to create a suitably permissioned user exclusively for API duties.
- All calls use the base URI:
http(s)://<server-host>:8082/api/<resource> - The Internet media type of the data supported by the web service is application/xml.
- The API is hypertext driven, using the following HTTP methods:
| Type | Action |
|---|---|
| POST | to create a resource on the server |
| GET | to retrieve a resource from the server |
| PUT | to modify the state of a resource |
| DELETE | to remove a resource |
1.3 Online documentation
You can review a copy of the bundled API documenation. This documentation is taken straight from a live installation. Given that the documentation is automatically generated, it frequently links to local files and resources that will not be available here.