Connector Type REST Endpoint

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

Description

Here we are describing the Connector object type in relation to midPoints REST API. The Connector objects are a part of the REST API web resources.accessCertificationDefinitions

Endpoint
connectors/

Operations And Examples

The Connector 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 Type Object

Get Connector Type Objects

Get operation for fetching a single specific object.

Search for Connector 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 Type Objects

Delete Connector Type Objects

Generate and Validate Operations for Generic Object Type Objects

Operations to generate or validate values.

JSON Example

Example output of information regarding a specific Connector object. Some parts of the output were removed or simplified for the purpose of the example.

Show JSON Example
{
	"connector": {
		"oid": "01aa0a9e-dfe0-47c8-8fca-4446894a348c",
		"version": "50",
		"name": "ConnId com.evolveum.polygon.connector.csv.CsvConnector v2.7",
		"displayName": "CsvConnector",
		"framework": "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1",
		"connectorType": "com.evolveum.polygon.connector.csv.CsvConnector",
		"connectorVersion": "2.7",
		"connectorBundle": "com.evolveum.polygon.connector-csv",
		"namespace": "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/bundle/com.evolveum.polygon.connector-csv/com.evolveum.polygon.connector.csv.CsvConnector",
		"schema": {},
		"available": true
	}
}
Was this page helpful?
YES NO
Thanks for your feedback