GET http://localhost:8080/midpoint/ws/rest/shadows/{oid}/ownerShadow Specific Operations
Description
A set of operations related specifically to the Shadow object type of midPoint.
Request
There are multiple possible requests which are specific for the Shadow object type related operations.
The first operation would be the fetch of the Shadow object (e.g. representing an account) owner . For this operation you will have to use the HTTP GET method in your request. The resulting uri could look something like this:
Get shadow owner operation
Another operation is the import of a Shadow object (e.g. again representing an account), thus either linking them to an existing object in midPoint or creating a midPoint object as a result of this operation.
Import shadow object
POST http://localhost:8080/midpoint/ws/rest/shadows/{oid}/importHeaders
Regarding authorization type, the "Basic" Authorization header should be used.
Authorization header example, replace {Base64EncodedCredentials} with the encoded credentials
Authorization: Basic {Base64EncodedCredentials}In case of the operations you 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
Body
No additional data needed in the request body.
Options
No additional option parameters supported for these types of requests.
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#findShadowOwner -
http://midpoint.evolveum.com/xml/ns/public/security/authorization-rest-3#importShadow
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.
For the find shadow owner authorization:
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#read
For the import shadow owner authorization:
-
http://midpoint.evolveum.com/xml/ns/public/security/authorization-model-3#importFromResource
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:
Get Shadow owner
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-X GET http://localhost:8080/midpoint/ws/rest/shadows/062ac29f-f296-4824-aeab-9a0feb9e8bd3/owner \
-vThe response is an HTTP 200 code in case of success with a response body containing the queried item.
Example Output of "Get Shadow owner" example
The example is simplified, some properties were removed to keep the example output "short". This example does not contain all possible properties of this object type.
{
"user" : {
"oid" : "a9885c61-c442-42d8-af34-8182a8653e3c",
"version" : "",
"name" : "Jack",
"metadata" : {},
"operationExecution" : [ {}, {} ],
"assignment" : [ {}, {} ],
"iteration" : 0,
"iterationToken" : "",
"roleMembershipRef" : [ {}, {} ],
"linkRef" : {
"oid" : "062ac29f-f296-4824-aeab-9a0feb9e8bd3",
"relation" : "org:default",
"type" : "c:ShadowType"
},
"activation" : {},
"emailAddress" : "jack@evolveum.com",
"credentials" : {},
"givenName" : "Jack",
"familyName" : "Sparrow"
}
}Import Shadow
curl --user administrator:y0uR_P455woR*d \
-H "Accept: application/json" \
-X POST http://localhost:8080/midpoint/ws/rest/shadows/062ac29f-f296-4824-aeab-9a0feb9e8bd3/import \
-vThe response is an HTTP 200 code in case of success with a response body containing the queried item.
Example Output of "Import shadow" example
The example is simplified, some properties were removed to keep the example output "short". This example does not contain all possible properties of this object type.
{
"@ns" : "http://prism.evolveum.com/xml/ns/public/types-3",
"object" : {
"@type" : "c:OperationResultType",
"operation" : "importShadow",
"status" : "success",
"importance" : "normal",
"start" : "",
"end" : "",
"microseconds" : ,
"invocationId" : ,
"token" : ,
"partialResults" : [ {} ]
}Was this page helpful?
YES
NO
Thanks for your feedback