-
201 Created, Location set to point to the newly created object
-
240 Handled error, OperationResult is returned in the body
-
250 Partial error, OperationResult is returned in the body
REST Operations
Supported Operations
The base URL of REST API is http://localhost:8080/midpoint/ws/rest (alternatively to /ws/rest paths /api/model and /rest/model are also supported).
-
Use the base URL + path from the table below to request concrete operation.
-
Supply the {type} with the specific type of object you want to add (or modify, delete, search, etc). Supported types are listed here
-
Supply the {oid} with the specific oid of your object.
-
Some operations support specifying options influencing the operation execution, e.g. if the execution is made in raw mode, or the shadows are not fetched from the resource, etc. Supported options column shows supported options for different operations. To specify option, use query parameters, e.g. http://localhots:8080/midpoint/api/model/users*?options=raw*
-
The data in the body should be written in one of the supported Media Types
| Operation name | Operation type | Path | Supported options | Data | Response |
|---|---|---|---|---|---|
POST |
/{type} |
Object to create |
|||
PUT |
/{type}/{oid} |
Object to create |
|
||
GET |
/{type}/{oid} |
- |
|
||
PATCH, POST |
/{type}/{oid} |
Modifications as in ObjectModificationType |
|
||
DELETE |
/{type}/{oid} |
- |
|
||
POST |
/resources/{oid}/test |
No |
- |
|
|
POST |
/resources/{oid}/import/{objectClass} |
No |
- |
|
|
GET |
/shadows/{oid}/owner |
No |
- |
|
|
POST |
/shadows/{oid}/import |
No |
- |
|
|
POST |
/{type}/search |
Query as in QueryType |
|
||
POST |
/tasks/{oid}/suspend |
No |
- |
|
|
POST |
/tasks/{oid}/resume |
No |
- |
|
|
POST |
/tasks/{oid}/run |
No |
- |
|
|
POST |
/notifyChange |
No |
Resource object shadow change description |
|
|
POST |
/{type}/{oid}/generate |
No |
Policy for items describing how to generate the value (PolicyItemsDefinitionType) |
|
|
POST |
/rpc/generate |
No |
PolicyItemsDefinitionType |
|
|
POST |
/{type}/{oid}/validate |
No |
PolicyItemsDefinitionType |
|
|
POST |
/rpc/validate |
No |
PolicyItemsDefinitionType |
|
|
GET |
/users/{oid}/policy |
No |
|
||
GET |
/self |
No |
|
||
GET |
/{type} |
|
|||
POST |
/users/{oid}/credential |
No |
ExecuteCredentialResetRequestType - specify reset method and new password |
|
|
POST |
/rpc/executeScript |
No |
ExecuteScriptType |
|
Was this page helpful?
YES
NO
Thanks for your feedback