Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Operation nameOperation typePath

Suports

options

DataResponse
Create new objectPOST

/{type} 

ModelExecuteOptionsTypeObject to create in the XML form

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

Create or update objectPUT

/{type}/{oid}

ModelExecuteOptionsTypeObject to create in the XML form

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

Get objectGET/{type}/{oid}GetOperationOptionsType-

200 OK, current object in the response body

Modify object  PATCH, POST/{type}/{oid}ModelExecuteOptionsTypeModifications in XML format

204 No Content

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Delete objectDELETE/{type}/{oid}ModelExecuteOptionsType-

204 No Content

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Test (configured) Resource

POST/resources/{oid}/testNo-200 OK, result of the test operation in the body

Import from Resource

POST

/resources/{oid}/import/{objectClass}

No-

303 See Other, Location set to point to the concrete "import" task

Find owner of shadow

GET

/shadows/{oid}/owner

No-

200 OK, owner of the shadow returned in the response body

Import shadow

POST

/shadows/{oid}/import

No-

200 OK, result of the import operation in the body

SearchPOST

/{type}/search

GetOperationOptionsTypeQuery in XML format200 OK, list of found objects in the body
Suspend tasksPOST/tasks/{oid}/suspendNo-204 No Content
Resume tasksPOST/tasks/{oid}/resumeNo-202 Accepted
Schedule task nowPOST/tasks/{oid}/runNo-202 Accepted
Notify changePOST/notifyChangeNoResource object shadow change description200 OK
Generate value for concrete objectPOST/{type}/{oid}/generateNoPolicy for items describing how to generate the value (PolicyItemsDefinitionType)

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Generate valuePOST/rpc/generateNoPolicyItemsDefinitionType

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Validate value for concrete objectPOST/{type}/{oid}/validateNoPolicyItemsDefinitionType

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Validate valuePOST/rpc/validateNoPolicyItemsDefinitionType

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Get user's value policyGET/users/{oid}/policyNo
200 OK, value policy for user in the response body
Get 'self'GET/selfNo
200 OK, current object in the response body
Search objects by typeGET/{type}GetOperationOptionsType
200 OK, list of object of specified type in the response body
Reset credentialsPOST/users/{oid}/credentialNoExecuteCredentialResetRequestType - specify reset method and new password 200 OK, ExecuteCredentialResetResponseType returned in the body. 

...