Modify Operation

Last modified 13 Mar 2024 13:32 +01:00

Table of Contents

Description
Request
- Headers
- Body
- Options
- Response
Access Authorization
Model Authorization
Examples
See Also

Description

Modification of objects based on payload data in the body of the REST request.

Request

Use either the HTTP POST or PATCH method with your request, both usages are equivalent, this is based on the possibility that not all clients are capable of using non-standard HTTP verbs.

INFO: The usage of HTTP PATCH is preferred, the meaning is clearer than the case of HTTP POST in the context of Modify.

Modify operation using HTTP POST

POST http://localhost:8080/midpoint/ws/rest/{endpoint}/{oid}

Modify operation using HTTP PATCH

PATCH http://localhost:8080/midpoint/ws/rest/{endpoint}/

Headers

Regarding authorization type, the "Basic" Authorization header should be used.

Authorization header example replace {Base64EncodedCredentials} with the encoded credentials

Authorization: Basic {Base64EncodedCredentials}

To specify the provided content type, please use the "Content-Type" header payload in the body:

Content type header example, other media types are supported as well

"Content-Type: application/json"

You might need to specify the accepted type of content in case you are interested in a format different from xml (default):

Accept type header example, other media types are supported as well

"Accept: application/json"

For supported media types please refer to the following section of the documentation

Supported Media Types

Body

The body should contain a payload consisting of a ObjectModificationType type of object containing an object delta. Please have a look on the examples on this page for a sample of the object in the body.

Options

Options are supported for this kind of operation. The options are a special kind of parameters with which we enhance a request. The specific type of options which can be used with this operation is ModelExecuteOptionsType

Usage of Operation Options

To use a boolean based operation option with your request, append a question mark "?" to the original request URI, then type in the "option=" string after which you append the name of the option to be used.

Options can be chained with the "&" character if you want to use multiple options in your request.

Example:

?options=raw&options=force

Response

Error code	Meaning
1xx	Information. Stay tuned, operation is in progress.
2xx	Success. Operation finished successfully. There are two custom codes: 250 for partial error which means that during processing some error occurred but some changes was executed. 240 for handled error which means that there was originally error, but midPoint was able to fix this using its consistency mechanism. In this two cases, midPoint returns the OperationResult where there details of executed operations can be found.
3xx	Redirection or "in progress". This is returned mostly to indicate two cases: Operation has finished, but the results are not in this resource. Redirection is issues to point the client to the results. Typical example is creation of an object with POST to a collection web resource. In this case a new object is created, new URI is assigned and the client is redirected to this URI. Retrieving that URI provides created object and 200 status code, indicating that the operation is finished. Operation is in progress (asynchronous operation). In this case midPoint API redirects the client to a task object that can be used to track progress of the operation.
4xx	Client errors. The client has sent request that cannot be processed. This indicates usual situation that are well handled by the midPoint code. Maybe the client request to create conflicting object, delete non-existent object, modification that violates the schema and so on. The OperationResult structure is usually provided in the response to provide more details about the situation.
5xx	Server errors. Situations that the server cannot handle and where the cause is unknown. This usually means bugs in the code, insufficient resources such as RAM or disk space, unforeseen failures in the infrastructure and so on. The OperationResult structure might or might not be provided in this case. Some errors are so severe that the structured error information might not be available.

Error code

Meaning

1xx

Information. Stay tuned, operation is in progress.

2xx

Success. Operation finished successfully. There are two custom codes:

250 for partial error which means that during processing some error occurred but some changes was executed.
240 for handled error which means that there was originally error, but midPoint was able to fix this using its consistency mechanism.

In this two cases, midPoint returns the OperationResult where there details of executed operations can be found.

3xx

Redirection or "in progress". This is returned mostly to indicate two cases:

Operation has finished, but the results are not in this resource. Redirection is issues to point the client to the results. Typical example is creation of an object with POST to a collection web resource. In this case a new object is created, new URI is assigned and the client is redirected to this URI. Retrieving that URI provides created object and 200 status code, indicating that the operation is finished.
Operation is in progress (asynchronous operation). In this case midPoint API redirects the client to a task object that can be used to track progress of the operation.

4xx

Client errors. The client has sent request that cannot be processed. This indicates usual situation that are well handled by the midPoint code. Maybe the client request to create conflicting object, delete non-existent object, modification that violates the schema and so on. The OperationResult structure is usually provided in the response to provide more details about the situation.

5xx

Server errors. Situations that the server cannot handle and where the cause is unknown. This usually means bugs in the code, insufficient resources such as RAM or disk space, unforeseen failures in the infrastructure and so on. The OperationResult structure might or might not be provided in this case. Some errors are so severe that the structured error information might not be available.

Status codes and the indication of errors and asynchronous processing applies uniformly to all midPoint web resources (both RESTful and RPC).

Access Authorization

The interface authorization needed for executing this type of request. The authorization is needed to access the specific part of the interface. For more information please see this page.

http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#modifyObject

Model Authorization

The model authorization for the specific action. This authorization is needed to request/execute the concrete action. The examples are usually quite broad, and the actions can be additionally specified for a more fine-grained authorization. For more information please see this page.

http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#modify

Examples

In our examples we are authenticating with the credentials, name "administrator" and password "y0uR_P455woR*d" on a localhost instance running on port 8080.

For some help regarding the REST examples please see this link:

How to use MidPoint REST examples

Modification of an attribute for specific user

curl --user administrator:y0uR_P455woR*d \
-H "Content-Type: application/json" \
-X PATCH http://localhost:8080/midpoint/ws/rest/users/00000000-0000-0000-0000-000000000002 \
-v \
--data-binary @./samples/rest/modify-attribute-gen.json -v

Show data source example for "Modify attribute value" | GitHub

{
	"objectModification": {
		"itemDelta": {
			"modificationType": "add",
			"path": "description",
			"value": "Description parameter modified via REST"
		}
	}
}

The response is an HTTP 204 code in case of success without a response body.