diff --git a/config/rest/index.html b/config/rest/index.html new file mode 100644 index 00000000000..a18c6a4305f --- /dev/null +++ b/config/rest/index.html @@ -0,0 +1,20149 @@ + + + + + MidPoint REST API + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

MidPoint REST API

+
+
+
+ +
+ + +
+

Default

+ + + + + + + +
+ +
+
+

addObject

+
+
+ +
+
+ +

+

Create a new object of a specified {type}, body represents object to be created in XML, JSON or YAML format

+

+
+ +
/{type}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}?options="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.addObject(type, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.addObject(type, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+Object *body = ; // 
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Add
+[apiInstance addObjectWith:type
+    body:body
+    options:options
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var body = ; // {Object} 
+
+var opts = { 
+  'options':  // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.addObject(type, body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class addObjectExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var body = new Object(); // Object | 
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType (optional) 
+
+            try
+            {
+                // Add
+                apiInstance.addObject(type, body, options);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.addObject: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to be created. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$body = ; // Object | 
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+
+try {
+    $api_instance->addObject($type, $body, $options);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->addObject: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
type* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + +
NameDescription
options + + + +
+
+ +

Responses

+ +

Status: 201 - Object successfully created

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

addOrUpdateObject

+
+
+ +
+
+ +

+

Create or update an object of a specified {type} identified with {id}, body represents object to be created or updated in XML, JSON or YAML format. If the object already exists option overwrite is automatically set to true

+

+
+ +
/{type}/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X put -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{oid}?options="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | 
+        try {
+            apiInstance.addOrUpdateObject(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addOrUpdateObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | 
+        try {
+            apiInstance.addOrUpdateObject(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#addOrUpdateObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *oid = oid_example; // Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+Object *body = ; // 
+array[String] *options = ; //  (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Create or update
+[apiInstance addOrUpdateObjectWith:type
+    oid:oid
+    body:body
+    options:options
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var oid = oid_example; // {String} Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+
+var body = ; // {Object} 
+
+var opts = { 
+  'options':  // {array[String]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.addOrUpdateObject(type, oid, body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class addOrUpdateObjectExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var oid = oid_example;  // String | Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+            var body = new Object(); // Object | 
+            var options = new array[String](); // array[String] |  (optional) 
+
+            try
+            {
+                // Create or update
+                apiInstance.addOrUpdateObject(type, oid, body, options);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.addOrUpdateObject: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to be created or updated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$oid = oid_example; // String | Oid of the object, either existing or new one. If the object already exists it will be overwritten. If the object doesn't exist, it will be created with given oid
+$body = ; // Object | 
+$options = ; // array[String] | 
+
+try {
+    $api_instance->addOrUpdateObject($type, $oid, $body, $options);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->addOrUpdateObject: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
oid* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + +
NameDescription
options + + + +
+
+ +

Responses

+ +

Status: 201 - Object successfully created

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

deleteObject

+
+
+ +
+
+ +

+

Delete an object with {id} of a specified {type}

+

+
+ +
/{type}/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X delete -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{oid}?options=&include=&exclude="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to delete
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            apiInstance.deleteObject(type, oid, options, include, exclude);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#deleteObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to delete
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            apiInstance.deleteObject(type, oid, options, include, exclude);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#deleteObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *oid = oid_example; // Oid of the object to delete
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType (optional)
+array[String] *include = ; //  (optional)
+array[String] *exclude = ; //  (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Delete operation
+[apiInstance deleteObjectWith:type
+    oid:oid
+    options:options
+    include:include
+    exclude:exclude
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var oid = oid_example; // {String} Oid of the object to delete
+
+var opts = { 
+  'options': , // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+  'include': , // {array[String]} 
+  'exclude':  // {array[String]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.deleteObject(type, oid, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class deleteObjectExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var oid = oid_example;  // String | Oid of the object to delete
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType (optional) 
+            var include = new array[String](); // array[String] |  (optional) 
+            var exclude = new array[String](); // array[String] |  (optional) 
+
+            try
+            {
+                // Delete operation
+                apiInstance.deleteObject(type, oid, options, include, exclude);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.deleteObject: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to delete. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$oid = oid_example; // String | Oid of the object to delete
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+$include = ; // array[String] | 
+$exclude = ; // array[String] | 
+
+try {
+    $api_instance->deleteObject($type, $oid, $options, $include, $exclude);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->deleteObject: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
oid* + + + +
+
+ + + + +
Query parameters
+ + + + + + + + + + + + + + + + + + +
NameDescription
options + + + +
+
include + + + +
+
exclude + + + +
+
+ +

Responses

+ +

Status: 200 - Object deleted successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

executeScript

+
+
+ +
+
+ +

+

Bulk-like operations. Body represents search filter and action description which will be executed. It can be run in both, synchronous and asynchronous way. While running in asynchronous way, new task is created.

+

+
+ +
/rpc/executeScript
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/rpc/executeScript?asynchronous="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        Object body = ; // Object | search filter and action definition see
+        Boolean asynchronous = true; // Boolean | specify if the operation will run asynchronous. When set to true, new task is created.
+        try {
+            Object result = apiInstance.executeScript(body, asynchronous);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeScript");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Object body = ; // Object | search filter and action definition see
+        Boolean asynchronous = true; // Boolean | specify if the operation will run asynchronous. When set to true, new task is created.
+        try {
+            Object result = apiInstance.executeScript(body, asynchronous);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeScript");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+Object *body = ; // search filter and action definition see
+Boolean *asynchronous = true; // specify if the operation will run asynchronous. When set to true, new task is created. (optional) (default to false)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Bulk-like operations
+[apiInstance executeScriptWith:body
+    asynchronous:asynchronous
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var body = ; // {Object} search filter and action definition see
+
+var opts = { 
+  'asynchronous': true // {Boolean} specify if the operation will run asynchronous. When set to true, new task is created.
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.executeScript(body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class executeScriptExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var body = new Object(); // Object | search filter and action definition see
+            var asynchronous = true;  // Boolean | specify if the operation will run asynchronous. When set to true, new task is created. (optional)  (default to false)
+
+            try
+            {
+                // Bulk-like operations
+                Object result = apiInstance.executeScript(body, asynchronous);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.executeScript: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$body = ; // Object | search filter and action definition see
+$asynchronous = true; // Boolean | specify if the operation will run asynchronous. When set to true, new task is created.
+
+try {
+    $result = $api_instance->executeScript($body, $asynchronous);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->executeScript: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + + + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + +
NameDescription
asynchronous + + + +
+
+ +

Responses

+ +

Status: 200 - If run sucessfully with asynchronous=false

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 201 - If started sucessfully with asynchronous=true.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

executeScriptResults

+
+
+ +
+
+ +

+

Return results for execute script operation. When /rpc/executeScript operation is called in asynchronous mode, new task is created and the oid of this task is returned to the user. Using returned oid from /rpc/executeScript operation as a parameter for /rpc/executeScriptResults operation shown an actual result of running/closed script execution

+

+
+ +
/executeScriptResults/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/executeScriptResults/{oid}"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task created for bulk action
+        try {
+            Object result = apiInstance.executeScriptResults(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeScriptResults");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task created for bulk action
+        try {
+            Object result = apiInstance.executeScriptResults(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeScriptResults");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *oid = oid_example; // Oid of the task created for bulk action
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Results for execute script operation
+[apiInstance executeScriptResultsWith:oid
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var oid = oid_example; // {String} Oid of the task created for bulk action
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.executeScriptResults(oid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class executeScriptResultsExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var oid = oid_example;  // String | Oid of the task created for bulk action
+
+            try
+            {
+                // Results for execute script operation
+                Object result = apiInstance.executeScriptResults(oid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.executeScriptResults: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$oid = oid_example; // String | Oid of the task created for bulk action
+
+try {
+    $result = $api_instance->executeScriptResults($oid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->executeScriptResults: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
oid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - If run sucessfully with asynchronous=false

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

generateValue

+
+
+ +
+
+ +

+

Generate new value for item specified in the request according to the value policy related to the object of {type} type identifier with {oid}

+

+
+ +
/{type}/{id}/generate
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{id}/generate"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String id = id_example; // String | oid of the object for which the value will be generated
+        Object body = ; // Object | path to the property which will be generated
+        try {
+            Object result = apiInstance.generateValue(type, id, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#generateValue");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String id = id_example; // String | oid of the object for which the value will be generated
+        Object body = ; // Object | path to the property which will be generated
+        try {
+            Object result = apiInstance.generateValue(type, id, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#generateValue");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *id = id_example; // oid of the object for which the value will be generated
+Object *body = ; // path to the property which will be generated
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Generate value according to value policy
+[apiInstance generateValueWith:type
+    id:id
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var id = id_example; // {String} oid of the object for which the value will be generated
+
+var body = ; // {Object} path to the property which will be generated
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.generateValue(type, id, body, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class generateValueExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var id = id_example;  // String | oid of the object for which the value will be generated
+            var body = new Object(); // Object | path to the property which will be generated
+
+            try
+            {
+                // Generate value according to value policy
+                Object result = apiInstance.generateValue(type, id, body);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.generateValue: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$id = id_example; // String | oid of the object for which the value will be generated
+$body = ; // Object | path to the property which will be generated
+
+try {
+    $result = $api_instance->generateValue($type, $id, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->generateValue: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
id* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ + +

Responses

+ +

Status: 200 - Successful operation

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

getObject

+
+
+ +
+
+ +

+

Get object with {id} of a specified {type}

+

+
+ +
/{type}/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{oid}?options=&include=&exclude="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to get
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            Object result = apiInstance.getObject(type, oid, options, include, exclude);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to get
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            Object result = apiInstance.getObject(type, oid, options, include, exclude);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getObject");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *oid = oid_example; // Oid of the object to get
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType
+array[String] *include = ; //  (optional)
+array[String] *exclude = ; //  (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Get operation
+[apiInstance getObjectWith:type
+    oid:oid
+    options:options
+    include:include
+    exclude:exclude
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var oid = oid_example; // {String} Oid of the object to get
+
+var options = ; // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+
+var opts = { 
+  'include': , // {array[String]} 
+  'exclude':  // {array[String]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getObject(type, oid, options, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class getObjectExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var oid = oid_example;  // String | Oid of the object to get
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType
+            var include = new array[String](); // array[String] |  (optional) 
+            var exclude = new array[String](); // array[String] |  (optional) 
+
+            try
+            {
+                // Get operation
+                Object result = apiInstance.getObject(type, oid, options, include, exclude);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.getObject: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to get. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$oid = oid_example; // String | Oid of the object to get
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+$include = ; // array[String] | 
+$exclude = ; // array[String] | 
+
+try {
+    $result = $api_instance->getObject($type, $oid, $options, $include, $exclude);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getObject: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
oid* + + + +
+
+ + + + +
Query parameters
+ + + + + + + + + + + + + + + + + + +
NameDescription
options* + + + +
+
include + + + +
+
exclude + + + +
+
+ +

Responses

+ +

Status: 200 - Object returned successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

getValuePolicyForUser

+
+
+ +
+
+ +

+

Get value policy specific for users. There might exist more value policies, e.g. different value policies for different tenants/organization units etc.

+

+
+ +
/users/{id}/policy
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/users/{id}/policy"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | oid of the user for which the value policy is returned
+        try {
+            Object result = apiInstance.getValuePolicyForUser(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getValuePolicyForUser");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String id = id_example; // String | oid of the user for which the value policy is returned
+        try {
+            Object result = apiInstance.getValuePolicyForUser(id);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getValuePolicyForUser");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *id = id_example; // oid of the user for which the value policy is returned
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Get value policy specific for user
+[apiInstance getValuePolicyForUserWith:id
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var id = id_example; // {String} oid of the user for which the value policy is returned
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getValuePolicyForUser(id, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class getValuePolicyForUserExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var id = id_example;  // String | oid of the user for which the value policy is returned
+
+            try
+            {
+                // Get value policy specific for user
+                Object result = apiInstance.getValuePolicyForUser(id);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.getValuePolicyForUser: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$id = id_example; // String | oid of the user for which the value policy is returned
+
+try {
+    $result = $api_instance->getValuePolicyForUser($id);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getValuePolicyForUser: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
id* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - Successful operation

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

importFromResource

+
+
+ +
+
+ +

+

Import object of {objectClass} from the resource identified by {resourceOid}

+

+
+ +
/resources/{resourceOid}/import/{objectClass}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/resources/{resourceOid}/import/{objectClass}"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String resourceOid = resourceOid_example; // String | Resource from which the objects are imported
+        String objectClass = objectClass_example; // String | Object class of the object being imported
+        try {
+            apiInstance.importFromResource(resourceOid, objectClass);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#importFromResource");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String resourceOid = resourceOid_example; // String | Resource from which the objects are imported
+        String objectClass = objectClass_example; // String | Object class of the object being imported
+        try {
+            apiInstance.importFromResource(resourceOid, objectClass);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#importFromResource");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *resourceOid = resourceOid_example; // Resource from which the objects are imported
+String *objectClass = objectClass_example; // Object class of the object being imported
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Import from resource
+[apiInstance importFromResourceWith:resourceOid
+    objectClass:objectClass
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var resourceOid = resourceOid_example; // {String} Resource from which the objects are imported
+
+var objectClass = objectClass_example; // {String} Object class of the object being imported
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.importFromResource(resourceOid, objectClass, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class importFromResourceExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var resourceOid = resourceOid_example;  // String | Resource from which the objects are imported
+            var objectClass = objectClass_example;  // String | Object class of the object being imported
+
+            try
+            {
+                // Import from resource
+                apiInstance.importFromResource(resourceOid, objectClass);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.importFromResource: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$resourceOid = resourceOid_example; // String | Resource from which the objects are imported
+$objectClass = objectClass_example; // String | Object class of the object being imported
+
+try {
+    $api_instance->importFromResource($resourceOid, $objectClass);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->importFromResource: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
resourceOid* + + + +
+
objectClass* + + + +
+
+ + + + + +

Responses

+ +

Status: 303 - Import task was created succesfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

modifyObjectPatch

+
+
+ +
+
+ +

+

Modify an object with {id} of a specified {type}

+

+
+ +
/{type}/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X patch -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{oid}?options="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to modify
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.modifyObjectPatch(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#modifyObjectPatch");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to modify
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.modifyObjectPatch(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#modifyObjectPatch");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *oid = oid_example; // Oid of the object to modify
+Object *body = ; // 
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Modify operation
+[apiInstance modifyObjectPatchWith:type
+    oid:oid
+    body:body
+    options:options
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var oid = oid_example; // {String} Oid of the object to modify
+
+var body = ; // {Object} 
+
+var opts = { 
+  'options':  // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.modifyObjectPatch(type, oid, body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class modifyObjectPatchExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var oid = oid_example;  // String | Oid of the object to modify
+            var body = new Object(); // Object | 
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType (optional) 
+
+            try
+            {
+                // Modify operation
+                apiInstance.modifyObjectPatch(type, oid, body, options);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.modifyObjectPatch: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$oid = oid_example; // String | Oid of the object to modify
+$body = ; // Object | 
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+
+try {
+    $api_instance->modifyObjectPatch($type, $oid, $body, $options);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->modifyObjectPatch: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
oid* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + +
NameDescription
options + + + +
+
+ +

Responses

+ +

Status: 204 - Object modified successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

modifyObjectPost

+
+
+ +
+
+ +

+

Modify an object with {id} of a specified {type}

+

+
+ +
/{type}/{oid}
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{oid}?options="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to modify
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.modifyObjectPost(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#modifyObjectPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String oid = oid_example; // String | Oid of the object to modify
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        try {
+            apiInstance.modifyObjectPost(type, oid, body, options);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#modifyObjectPost");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *oid = oid_example; // Oid of the object to modify
+Object *body = ; // 
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Modify operation
+[apiInstance modifyObjectPostWith:type
+    oid:oid
+    body:body
+    options:options
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var oid = oid_example; // {String} Oid of the object to modify
+
+var body = ; // {Object} 
+
+var opts = { 
+  'options':  // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.modifyObjectPost(type, oid, body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class modifyObjectPostExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var oid = oid_example;  // String | Oid of the object to modify
+            var body = new Object(); // Object | 
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType (optional) 
+
+            try
+            {
+                // Modify operation
+                apiInstance.modifyObjectPost(type, oid, body, options);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.modifyObjectPost: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$oid = oid_example; // String | Oid of the object to modify
+$body = ; // Object | 
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+
+try {
+    $api_instance->modifyObjectPost($type, $oid, $body, $options);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->modifyObjectPost: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
oid* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + +
NameDescription
options + + + +
+
+ +

Responses

+ +

Status: 204 - Object modified successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

notifyChange

+
+
+ +
+
+ +

+

Synchronization-like operation.

+

+
+ +
/notifyChange
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/notifyChange"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        Object body = ; // Object | 
+        try {
+            apiInstance.notifyChange(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#notifyChange");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        Object body = ; // Object | 
+        try {
+            apiInstance.notifyChange(body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#notifyChange");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+Object *body = ; // 
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Notify
+[apiInstance notifyChangeWith:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var body = ; // {Object} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.notifyChange(body, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class notifyChangeExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var body = new Object(); // Object | 
+
+            try
+            {
+                // Notify
+                apiInstance.notifyChange(body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.notifyChange: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$body = ; // Object | 
+
+try {
+    $api_instance->notifyChange($body);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->notifyChange: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + + + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ + +

Responses

+ +

Status: 200 - Operation run successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

resumeTasks

+
+
+ +
+
+ +

+

Resume task identified by {oid}

+

+
+ +
/tasks/{oid}/resume
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/tasks/{oid}/resume"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to be resumed
+        try {
+            'String' result = apiInstance.resumeTasks(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#resumeTasks");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to be resumed
+        try {
+            'String' result = apiInstance.resumeTasks(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#resumeTasks");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *oid = oid_example; // Oid of the task to be resumed
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Resume task
+[apiInstance resumeTasksWith:oid
+              completionHandler: ^('String' output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var oid = oid_example; // {String} Oid of the task to be resumed
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.resumeTasks(oid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class resumeTasksExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var oid = oid_example;  // String | Oid of the task to be resumed
+
+            try
+            {
+                // Resume task
+                'String' result = apiInstance.resumeTasks(oid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.resumeTasks: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$oid = oid_example; // String | Oid of the task to be resumed
+
+try {
+    $result = $api_instance->resumeTasks($oid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->resumeTasks: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
oid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - Task resumed successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

scheduleTasksNow

+
+
+ +
+
+ +

+

Run now task identified by {oid}

+

+
+ +
/tasks/{oid}/run
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/tasks/{oid}/run"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to run
+        try {
+            'String' result = apiInstance.scheduleTasksNow(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#scheduleTasksNow");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to run
+        try {
+            'String' result = apiInstance.scheduleTasksNow(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#scheduleTasksNow");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *oid = oid_example; // Oid of the task to run
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Run task now
+[apiInstance scheduleTasksNowWith:oid
+              completionHandler: ^('String' output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var oid = oid_example; // {String} Oid of the task to run
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.scheduleTasksNow(oid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class scheduleTasksNowExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var oid = oid_example;  // String | Oid of the task to run
+
+            try
+            {
+                // Run task now
+                'String' result = apiInstance.scheduleTasksNow(oid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.scheduleTasksNow: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$oid = oid_example; // String | Oid of the task to run
+
+try {
+    $result = $api_instance->scheduleTasksNow($oid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->scheduleTasksNow: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
oid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - Task run successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

searchObjects

+
+
+ +
+
+ +

+

Search object according to provided query in the body of a specified {type}

+

+
+ +
/{type}/search
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/search?options=&include=&exclude="
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            Object result = apiInstance.searchObjects(type, body, options, include, exclude);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#searchObjects");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        Object body = ; // Object | 
+        array[String] options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+        array[String] include = ; // array[String] | 
+        array[String] exclude = ; // array[String] | 
+        try {
+            Object result = apiInstance.searchObjects(type, body, options, include, exclude);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#searchObjects");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+Object *body = ; // 
+array[String] *options = ; // Additional options for operation, see ModelExecuteOptionsType (optional)
+array[String] *include = ; //  (optional)
+array[String] *exclude = ; //  (optional)
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Search objects
+[apiInstance searchObjectsWith:type
+    body:body
+    options:options
+    include:include
+    exclude:exclude
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var body = ; // {Object} 
+
+var opts = { 
+  'options': , // {array[String]} Additional options for operation, see ModelExecuteOptionsType
+  'include': , // {array[String]} 
+  'exclude':  // {array[String]} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.searchObjects(type, body, opts, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class searchObjectsExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var body = new Object(); // Object | 
+            var options = new array[String](); // array[String] | Additional options for operation, see ModelExecuteOptionsType (optional) 
+            var include = new array[String](); // array[String] |  (optional) 
+            var exclude = new array[String](); // array[String] |  (optional) 
+
+            try
+            {
+                // Search objects
+                Object result = apiInstance.searchObjects(type, body, options, include, exclude);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.searchObjects: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object to modify. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$body = ; // Object | 
+$options = ; // array[String] | Additional options for operation, see ModelExecuteOptionsType
+$include = ; // array[String] | 
+$exclude = ; // array[String] | 
+
+try {
+    $result = $api_instance->searchObjects($type, $body, $options, $include, $exclude);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->searchObjects: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
type* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ +
Query parameters
+ + + + + + + + + + + + + + + + + + +
NameDescription
options + + + +
+
include + + + +
+
exclude + + + +
+
+ +

Responses

+ +

Status: 200 - Objects found successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

searchShadowOwner

+
+
+ +
+
+ +

+

Get the (focus) owner of a shadow identifier by {oid}

+

+
+ +
/shadows/{oid}/owner
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/shadows/{oid}/owner"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the shadow for which the owner will be searched
+        try {
+            Object result = apiInstance.searchShadowOwner(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#searchShadowOwner");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the shadow for which the owner will be searched
+        try {
+            Object result = apiInstance.searchShadowOwner(oid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#searchShadowOwner");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *oid = oid_example; // Oid of the shadow for which the owner will be searched
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Get shadow owner
+[apiInstance searchShadowOwnerWith:oid
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var oid = oid_example; // {String} Oid of the shadow for which the owner will be searched
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.searchShadowOwner(oid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class searchShadowOwnerExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var oid = oid_example;  // String | Oid of the shadow for which the owner will be searched
+
+            try
+            {
+                // Get shadow owner
+                Object result = apiInstance.searchShadowOwner(oid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.searchShadowOwner: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$oid = oid_example; // String | Oid of the shadow for which the owner will be searched
+
+try {
+    $result = $api_instance->searchShadowOwner($oid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->searchShadowOwner: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
oid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - Shadow owner found successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

suspendTasks

+
+
+ +
+
+ +

+

Suspend task identified by {oid}

+

+
+ +
/tasks/{oid}/suspend
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/tasks/{oid}/suspend"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to suspend
+        try {
+            apiInstance.suspendTasks(oid);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#suspendTasks");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String oid = oid_example; // String | Oid of the task to suspend
+        try {
+            apiInstance.suspendTasks(oid);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#suspendTasks");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *oid = oid_example; // Oid of the task to suspend
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Suspend task
+[apiInstance suspendTasksWith:oid
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var oid = oid_example; // {String} Oid of the task to suspend
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.suspendTasks(oid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class suspendTasksExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var oid = oid_example;  // String | Oid of the task to suspend
+
+            try
+            {
+                // Suspend task
+                apiInstance.suspendTasks(oid);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.suspendTasks: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$oid = oid_example; // String | Oid of the task to suspend
+
+try {
+    $api_instance->suspendTasks($oid);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->suspendTasks: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
oid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - Task suspended successfully

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

testResource

+
+
+ +
+
+ +

+

Test connection and configuration for resource identifed by {resourceOid}

+

+
+ +
/resources/{resourceOid}/test
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/resources/{resourceOid}/test"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String resourceOid = resourceOid_example; // String | Oid of the resource to test
+        try {
+            Object result = apiInstance.testResource(resourceOid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#testResource");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String resourceOid = resourceOid_example; // String | Oid of the resource to test
+        try {
+            Object result = apiInstance.testResource(resourceOid);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#testResource");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *resourceOid = resourceOid_example; // Oid of the resource to test
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Test
+[apiInstance testResourceWith:resourceOid
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var resourceOid = resourceOid_example; // {String} Oid of the resource to test
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.testResource(resourceOid, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class testResourceExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var resourceOid = resourceOid_example;  // String | Oid of the resource to test
+
+            try
+            {
+                // Test
+                Object result = apiInstance.testResource(resourceOid);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.testResource: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$resourceOid = resourceOid_example; // String | Oid of the resource to test
+
+try {
+    $result = $api_instance->testResource($resourceOid);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->testResource: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + +
NameDescription
resourceOid* + + + +
+
+ + + + + +

Responses

+ +

Status: 200 - successful operation

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ + + + + + + + +
+ +
+
+

validateValue

+
+
+ +
+
+ +

+

Validate value of some attribute according to value policy. Value policy is chosen according to the object identification provided in the path {type}, {oid}.

+

+
+ +
/{type}/{id}/validate
+ +

+

Usage and SDK Samples

+

+ + + +
+
+

+curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost/midpoint/ws/rest/{type}/{id}/validate"
+
+
+
+
+ +
+

+import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import .DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        ApiClient defaultClient = Configuration.getDefaultApiClient();
+        
+        // Configure HTTP basic authorization: m_basic
+        HttpBasicAuth m_basic = (HttpBasicAuth) defaultClient.getAuthentication("m_basic");
+        m_basic.setUsername("YOUR USERNAME");
+        m_basic.setPassword("YOUR PASSWORD");
+
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String id = id_example; // String | oid of the object for which the value will be generated
+        Object body = ; // Object | path to the property which will be generated
+        try {
+            Object result = apiInstance.validateValue(type, id, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#validateValue");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + +
+

+import .DefaultApi;
+
+public class DefaultApiExample {
+
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+        String id = id_example; // String | oid of the object for which the value will be generated
+        Object body = ; // Object | path to the property which will be generated
+        try {
+            Object result = apiInstance.validateValue(type, id, body);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#validateValue");
+            e.printStackTrace();
+        }
+    }
+}
+
+                                                  
+
+ + + + +
+

+Configuration *apiConfig = [Configuration sharedConfig];
+// Configure HTTP basic authorization (authentication scheme: m_basic)
+[apiConfig setUsername:@"YOUR_USERNAME"];
+[apiConfig setPassword:@"YOUR_PASSWORD"];
+
+
+String *type = type_example; // type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+String *id = id_example; // oid of the object for which the value will be generated
+Object *body = ; // path to the property which will be generated
+
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Validate value according to value policy
+[apiInstance validateValueWith:type
+    id:id
+    body:body
+              completionHandler: ^(Object output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+                                                    
+
+
+

+var  = require('');
+var defaultClient = .ApiClient.instance;
+
+// Configure HTTP basic authorization: m_basic
+var m_basic = defaultClient.authentications['m_basic'];
+m_basic.username = 'YOUR USERNAME'
+m_basic.password = 'YOUR PASSWORD'
+
+var api = new .DefaultApi()
+
+var type = type_example; // {String} type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+
+var id = id_example; // {String} oid of the object for which the value will be generated
+
+var body = ; // {Object} path to the property which will be generated
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.validateValue(type, id, body, callback);
+
+                                                    
+
+ + + +
+

+using System;
+using System.Diagnostics;
+using .Api;
+using .Client;
+using ;
+
+namespace Example
+{
+    public class validateValueExample
+    {
+        public void main()
+        {
+            
+            // Configure HTTP basic authorization: m_basic
+            Configuration.Default.Username = "YOUR_USERNAME";
+            Configuration.Default.Password = "YOUR_PASSWORD";
+
+            var apiInstance = new DefaultApi();
+            var type = type_example;  // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+            var id = id_example;  // String | oid of the object for which the value will be generated
+            var body = new Object(); // Object | path to the property which will be generated
+
+            try
+            {
+                // Validate value according to value policy
+                Object result = apiInstance.validateValue(type, id, body);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling DefaultApi.validateValue: " + e.Message );
+            }
+        }
+    }
+}
+
+                                                    
+
+ + +
+

+setUsername('YOUR_USERNAME');
+io.swagger.client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');
+
+$api_instance = new io.swagger.client\Api\DefaultApi();
+$type = type_example; // String | type of the object for which the value will be generated. Possible values are connectors, connectorHosts, genericObjects, resources, users, objectTemplates, systemConfigurations, tasks, shadows, roles, valuePolicies, orgs, services
+$id = id_example; // String | oid of the object for which the value will be generated
+$body = ; // Object | path to the property which will be generated
+
+try {
+    $result = $api_instance->validateValue($type, $id, $body);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->validateValue: ', $e->getMessage(), PHP_EOL;
+}
+
+                                                  
+
+ +
+ + + + + +

Parameters

+ + + +
Path parameters
+ + + + + + + + + + + + + + +
NameDescription
type* + + + +
+
id* + + + +
+
+ + + +
Body parameters
+ + + + + + + + + + + +
NameDescription
body * + + + +
+
+ + +

Responses

+ +

Status: 200 - Successful operation

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 403 - Any of the security violations, e.g. insufficient access rights, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 404 - Requested object was not found.

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 406 - Bad request, e.g. bad object in the request, missing mandatory fields, ...

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 409 - The same object already exists

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 500 - Any unknown error, mostly runtuime/unchecked exceptions

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 502 - Configuration problems

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + +

Status: 503 - Communication problem while provisioning

+ + + + + + + + + +
+ + + +
+ + + + +
+ + +
+ + + + + + + +
+ + + + +
+ + + + + + + + + +
+ +
+ +
+ +
+ + + + + + +
+ + + + + + + +
+
+ Generated 2017-03-01T19:39:15.972+01:00 +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + diff --git a/config/rest/swagger.yml b/config/rest/swagger.yml index 228d597ab14..54819e9f0b4 100644 --- a/config/rest/swagger.yml +++ b/config/rest/swagger.yml @@ -224,7 +224,7 @@ paths: post: summary: "Validate value according to value policy" description: "Validate value of some attribute according to value policy. Value policy is chosen according to the object identification provided in the path {type}, {oid}." - operationId: "getValuePolicyForUser" + operationId: "validateValue" consumes: - "application/json" - "application/xml" @@ -288,6 +288,62 @@ paths: schema: type: "object" description: "see OperationResultType" + /users/{id}/policy: + get: + summary: "Get value policy specific for user" + description: "Get value policy specific for users. There might exist more value policies, e.g. different value policies for different tenants/organization units etc. " + operationId: "getValuePolicyForUser" + produces: + - "application/json" + - "application/xml" + - "application/yaml" + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "oid of the user for which the value policy is returned" + responses: + 200: + description: "Successful operation" + schema: + description: "see CredentialsPolicyType" + type: "object" + 404: + description: "Requested object was not found." + schema: + type: "object" + description: "see OperationResultType" + 503: + description: "Communication problem while provisioning" + schema: + type: "object" + description: "see OperationResultType" + 403: + description: "Any of the security violations, e.g. insufficient access rights, ..." + schema: + type: "object" + description: "see OperationResultType" + 502: + description: "Configuration problems" + schema: + type: "object" + description: "see OperationResultType" + 406: + description: "Bad request, e.g. bad object in the request, missing mandatory fields, ..." + schema: + type: "object" + description: "see OperationResultType" + 409: + description: "The same object already exists" + schema: + type: "object" + description: "see OperationResultType" + 500: + description: "Any unknown error, mostly runtuime/unchecked exceptions" + schema: + type: "object" + description: "see OperationResultType" /{type}: post: summary: "Add" diff --git a/gui/admin-gui/pom.xml b/gui/admin-gui/pom.xml index 1600742e0e2..b19ed6dc653 100644 --- a/gui/admin-gui/pom.xml +++ b/gui/admin-gui/pom.xml @@ -95,8 +95,15 @@ + + + org.webjars + swagger-ui + 2.2.5 + runtime + org.webjars.bower