connectorHosts/
Connector Host Type REST Endpoint
Description
Here we are describing the Connector Host object type in relation to midPoints REST API. The Connector Host objects are a part of the REST API web resources.
Operations And Examples
The Connector Host Type endpoint operations and 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:
Create Connector Host Type Object
Search for Connector Host Type Objects
Search operation usable for fetching the full list of objects or a list based on filter.
Show data source example for "Search for all" | GitHub
{
"query" : ""
}
The response is an HTTP 200 code in case of success with a response body containing the queried items.
Example Output is a list of objects.
{
"@ns" : "http://prism.evolveum.com/xml/ns/public/types-3",
"object" : {
"@type" : "http://midpoint.evolveum.com/xml/ns/public/common/api-types-3#ObjectListType",
"object" : [ {
"@type" : "",
"oid" : "",
"version" : "",
"name" : "",
"metadata" : {},
"operationExecution": {},
"indestructible": ,
"iteration" : ,
"iterationToken" : "",
"archetypeRef": {},
"roleMembershipRef": {},
"activation": {}
}, {
"@type" : "",
"oid" : "",
"version" : "",
"name" : "",
"metadata" : {},
"operationExecution": {},
"indestructible": ,
"iteration" : ,
"iterationToken" : "",
"archetypeRef": {},
"roleMembershipRef": {},
"activation": {}
} ]
}
}
Modify Connector Host Type Objects
Delete Connector Host Type Objects
Generate and Validate Operations for Connector Host Type Objects
Operations to generate or validate values.
JSON Example
Example output of information regarding a specific Connector Host object. Metadata is usually a part of the output, yet it was removed for the purpose of the example.
Show JSON Example
{
"connectorHost" : {
"oid" : "d90c34e2-7d69-4ba8-ba54-cde37ae8d4ab",
"version" : "1",
"name" : "ICF Connector server on localhost:8759",
"metadata" : {},
"operationExecution" : {},
"iteration" : 0,
"iterationToken" : "",
"hostname" : "localhost",
"port" : "8759",
"sharedSecret" : {}
}
}