API Reference

REST endpoints

Name	Base path	Description
Identity	/api/v1/identities	Working with identities/users
Role	/api/v1/roles	Working with roles
Role change request	/api/v1/role-requests	Working with request for change assigned roles on identity
Role concept	/api/v1/concept-role-requests	Create individual role concept for Role change request

Basic rules The API for CzechIdM is based on the REST principles. To use the API, you must be authenticated to CzechIdM.

`PUT /api/v1/identities/john_doe` - identity change john_doe, if there is no error returned` 404`

`DELETE /api/v1/identities/john_doe` - deleting identity john_doe, if there is no error returned` 404`

API uses three basic URL levels

`/api/v1/identities/john_doe`
- entity detail with convention `/api/v1/identities/${backendId}` - where `${backendId}` is entity uuid identifier or unique code, if entity supports `Codeable` interface.
`/api/v1/identities/john_doe/accounts/1`
- sub entity detail
`/api/v1/identities/john_doe/accounts/1/attribute/homeDirectory`

The default data format returned by the application interface is JSON. The change can be done in the HTTP request header.

Supported formats:

Date format (iso-8601):

`200` OK - The request was processed correctly.
`201` Created - The request was processed correctly and the object was created.
`202` Accepted - The request has been accepted correctly but has not yet been processed.
`204` OK - The request was processed correctly and the operation returns no response (eg delete operation)
`400` Bad Request - The request is not correct or all parameters are not entered.
`401` Unauthorized - Authentication error or user not authorized to perform this operation.
`403` Forbidden - Access denied.
`404` Not Found - Not Found.
`400` (405) 'Method Not Allowed - The requested method is not supported for the selected object type. This code is currently not supported. In this case, code 400 is returned with Method Not Allowed.
`409` Object already exists - The created object already exists. This value returns the server if someone attempts to create an object of the same type with an existing `name`.
`500` Internal server error - Internal server error