POST http://localhost:8080/midpoint/ws/rest/{endpoint}/{oid}/generate
Generate and Validate Operations for Specific objects
Description
Request to validate or generate a value for a specific object on midPoint. The operations url in this case contains a unique identifier of the object, for which we generate/validate a value and also the endpoint part of the URI of the object.
Request
For the request use the HTTP POST for the request.
The client has to provide the type of the web resource used in the request "{endpoint}" and the oid of the specific object for which we execute the operation "{oid}".
POST http://localhost:8080/midpoint/ws/rest/{endpoint}/{oid}/validate
Headers
Regarding authorization type, the "Basic" Authorization header should be used.
Authorization: Basic {Base64EncodedCredentials}
Another header would be the Content-Type Header.
"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: application/json"
Body
The body should contain a payload consisting of a policyItemDefinition type of object. Based on the use case you might need to specify which value policy should be used for the operation or which item should be the target of the operation. Please see the examples below.
Options
There are no supported operation options for this type of operation.
Response
Error code | Meaning |
---|---|
1xx |
Information. Stay tuned, operation is in progress. |
2xx |
Success. Operation finished successfully. There are two custom codes:
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:
|
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#generateValue
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#validateValue
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#get
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#read
Additionally, for generate:
-
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:
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-X POST http://localhost:8080/midpoint/ws/rest/roles/ae660563-11e6-41e1-8920-82725cc77021/generate \
-v \
--data-binary @./samples/rest/policy-items-identifier-generate.json
Show data source example for "Generate identifier for object" | GitHub
{
"policyItemsDefinition": {
"policyItemDefinition": {
"target": {
"path": "identifier"
},
"execute": "true"
}
}
}
The response is an HTTP 200 code in case of success with a response body.
Show example output for "Generate identifier for object"
{
"@ns" : "http://prism.evolveum.com/xml/ns/public/types-3",
"object" : {
"@type" : "http://midpoint.evolveum.com/xml/ns/public/common/api-types-3#PolicyItemsDefinitionType",
"policyItemDefinition" : [ {
"target" : {
"path" : "identifier"
},
"value" : {
"@type" : "xsd:string",
"@value" : "s2cMJrD5^21"
},
"execute" : true
} ]
}
}