Page tree

Versions Compared

Key

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

Version: 4.0
Status: Public
Stability: STABLE, only backward-compatible changes expected
Platform: RESTful interface
Dependencies: Data Model, Common schema, Query schema
Responsible person: Katarina Valalikova

Note

This feature is available in midPoint version 3.0 and later.

Table of Contents

Description

...

classREST type
ConnectorTypeconnectors
ConnectorHostTypeconnectorHosts
GenericObjectTypegenericObjects
ResourceTyperesources
UserTypeusers
ObjectTemplateTypeobjectTemplates
SystemConfigurationTypesystemConfigurations
TaskTypetasks
ShadowTypeshadows
RoleTyperoles
ValuePolicyTypevaluePolicies
NodeTypenodes
FormTypeforms
OrgTypeorgs
ReportTypereports
ReportOutputTypereportOutputs
SecurityPolicyTypesecurityPolicies
AccessCertificationDefinitionTypeaccessCertificationDefinitions
AccessCertificationCampaignTypeaccessCertificationCampaigns
ServiceTypeservices
FunctionLibraryTypefunctionLibraries
ObjectCollectionTypeobjectCollections
ArchetypeTypearchetypes
DashboardTypedashboards

Table 1. Supported types.

...

Operation nameOperation typePathDataResponse
Create new objectPOST

/{type} 

Object 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}

Object 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}-

200 OK, current object in the response body

Modify object  PATCH, POST/{type}/{oid}Modifications 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}-

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}/test-200 OK, result of the test operation in the body

Import from Resource

POST

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

-

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

Find owner of shadow

GET

/shadows/{oid}/owner

-

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

Import shadow

POST

/shadows/{oid}/import

-

200 OK, result of the import operation in the body

SearchPOST

/{type}/search

Query in XML format200 OK, list of found objects in the body
Suspend tasksPOST/tasks/{oid}/suspend-204 No Content
Resume tasksPOST/tasks/{oid}/resume-202 Accepted
Schedule task nowPOST/tasks/{oid}/run-202 Accepted
Notify changePOST/notifyChangeResource object shadow change description200 OK
Generate value for concrete objectPOST/{type}/{oid}/generatePolicy 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/generatePolicyItemsDefinitionType

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}/validatePolicyItemsDefinitionType

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Validate valuePOST/rpc/validatePolicyItemsDefinitionType

200 OK

240 Handled error, OperationResult is returned in the body

250 Partial error, OperationResult is returned in the body

Get 'self'GET/self
200 OK, current object in the response body
Get objects by typeGET/{type}
200 OK, list of object of specified type in the response body
Reset credentialsPOST/users/{oid}/credentialExecuteCredentialResetRequestType - specify reset method and new password 200 OK, ExecuteCredentialResetResponseType returned in the body. 


Sample usage

Info

If you are using file as a source for the data in the REST call, please, don't forget to use '@' before the path to your file

...