AD Connect Sync Connectors

Get Domains/Suffixes

This endpoint returns list of domains or suffixes to AD Connect Sync tool where one of the selected domain will be used as a default domain for new object creation.


/YOUR_CONNECTOR_NAME/{root}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        try {
            CloudDirectory result = apiInstance.activeDirectoryGet(root);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#activeDirectoryGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        try {
            CloudDirectory result = apiInstance.activeDirectoryGet(root);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#activeDirectoryGet");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Get AD Suffix
[apiInstance activeDirectoryGetWith:root
              completionHandler: ^(CloudDirectory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activeDirectoryGet(root, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class activeDirectoryGetExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 

            try
            {
                // Get AD Suffix
                CloudDirectory result = apiInstance.activeDirectoryGet(root);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.activeDirectoryGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 

try {
    $result = $api_instance->activeDirectoryGet($root);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->activeDirectoryGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 

eval { 
    my $result = $api_instance->activeDirectoryGet(root => $root);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->activeDirectoryGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 

try: 
    # Get AD Suffix
    api_response = api_instance.active_directory_get(root)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->activeDirectoryGet: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required

Responses

Status: 200 - OK

Create New Object

This endpoint will create new object at the cloud and will return newly created cloud object GUID (CloudGUID) and UniqueIdentifier that will be used by AD Connect Sync tool for object mapping. This endpoint will also handle newly created object's mapping at cloud level.


/YOUR_CONNECTOR_NAME/{root}/Object/Create
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        CreateObjectModel userDetails = ; // CreateObjectModel | 
        try {
            ObjectResponseModel result = apiInstance.createNewObject(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#createNewObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        CreateObjectModel userDetails = ; // CreateObjectModel | 
        try {
            ObjectResponseModel result = apiInstance.createNewObject(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#createNewObject");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
CreateObjectModel *userDetails = ; // 

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Create New Object
[apiInstance createNewObjectWith:root
    userDetails:userDetails
              completionHandler: ^(ObjectResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var userDetails = ; // {CreateObjectModel} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNewObject(root, userDetails, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNewObjectExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var userDetails = new CreateObjectModel(); // CreateObjectModel | 

            try
            {
                // Create New Object
                ObjectResponseModel result = apiInstance.createNewObject(root, userDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.createNewObject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$userDetails = ; // CreateObjectModel | 

try {
    $result = $api_instance->createNewObject($root, $userDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->createNewObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $userDetails = WWW::SwaggerClient::Object::CreateObjectModel->new(); # CreateObjectModel | 

eval { 
    my $result = $api_instance->createNewObject(root => $root, userDetails => $userDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->createNewObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
userDetails =  # CreateObjectModel | 

try: 
    # Create New Object
    api_response = api_instance.create_new_object(root, userDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->createNewObject: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Body parameters
Name Description
userDetails *

Responses

Status: 200 - OK

Get Object Details

This endpoint will return the cloud object details if exists. It will either receive CloudGUID or LocalGUID and the details of that object will be returned to the tool.


/YOUR_CONNECTOR_NAME/{root}/Object/Details
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String criteria.localGUID = criteria.localGUID_example; // String | 
        String criteria.cloudGUID = criteria.cloudGUID_example; // String | 
        String criteria.objectType = criteria.objectType_example; // String | 
        String criteria.uniqueIdentifier = criteria.uniqueIdentifier_example; // String | 
        try {
            ObjectResponseModel result = apiInstance.getObjectDetails(root, criteria.localGUID, criteria.cloudGUID, criteria.objectType, criteria.uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#getObjectDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String criteria.localGUID = criteria.localGUID_example; // String | 
        String criteria.cloudGUID = criteria.cloudGUID_example; // String | 
        String criteria.objectType = criteria.objectType_example; // String | 
        String criteria.uniqueIdentifier = criteria.uniqueIdentifier_example; // String | 
        try {
            ObjectResponseModel result = apiInstance.getObjectDetails(root, criteria.localGUID, criteria.cloudGUID, criteria.objectType, criteria.uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#getObjectDetails");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
String *criteria.localGUID = criteria.localGUID_example; //  (optional)
String *criteria.cloudGUID = criteria.cloudGUID_example; //  (optional)
String *criteria.objectType = criteria.objectType_example; //  (optional)
String *criteria.uniqueIdentifier = criteria.uniqueIdentifier_example; //  (optional)

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Get Object Details
[apiInstance getObjectDetailsWith:root
    criteria.localGUID:criteria.localGUID
    criteria.cloudGUID:criteria.cloudGUID
    criteria.objectType:criteria.objectType
    criteria.uniqueIdentifier:criteria.uniqueIdentifier
              completionHandler: ^(ObjectResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var opts = { 
  'criteria.localGUID': criteria.localGUID_example, // {String} 
  'criteria.cloudGUID': criteria.cloudGUID_example, // {String} 
  'criteria.objectType': criteria.objectType_example, // {String} 
  'criteria.uniqueIdentifier': criteria.uniqueIdentifier_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getObjectDetails(root, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getObjectDetailsExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var criteria.localGUID = criteria.localGUID_example;  // String |  (optional) 
            var criteria.cloudGUID = criteria.cloudGUID_example;  // String |  (optional) 
            var criteria.objectType = criteria.objectType_example;  // String |  (optional) 
            var criteria.uniqueIdentifier = criteria.uniqueIdentifier_example;  // String |  (optional) 

            try
            {
                // Get Object Details
                ObjectResponseModel result = apiInstance.getObjectDetails(root, criteria.localGUID, criteria.cloudGUID, criteria.objectType, criteria.uniqueIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.getObjectDetails: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$criteria.localGUID = criteria.localGUID_example; // String | 
$criteria.cloudGUID = criteria.cloudGUID_example; // String | 
$criteria.objectType = criteria.objectType_example; // String | 
$criteria.uniqueIdentifier = criteria.uniqueIdentifier_example; // String | 

try {
    $result = $api_instance->getObjectDetails($root, $criteria.localGUID, $criteria.cloudGUID, $criteria.objectType, $criteria.uniqueIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->getObjectDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $criteria.localGUID = criteria.localGUID_example; # String | 
my $criteria.cloudGUID = criteria.cloudGUID_example; # String | 
my $criteria.objectType = criteria.objectType_example; # String | 
my $criteria.uniqueIdentifier = criteria.uniqueIdentifier_example; # String | 

eval { 
    my $result = $api_instance->getObjectDetails(root => $root, criteria.localGUID => $criteria.localGUID, criteria.cloudGUID => $criteria.cloudGUID, criteria.objectType => $criteria.objectType, criteria.uniqueIdentifier => $criteria.uniqueIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->getObjectDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
criteria.localGUID = criteria.localGUID_example # String |  (optional)
criteria.cloudGUID = criteria.cloudGUID_example # String |  (optional)
criteria.objectType = criteria.objectType_example # String |  (optional)
criteria.uniqueIdentifier = criteria.uniqueIdentifier_example # String |  (optional)

try: 
    # Get Object Details
    api_response = api_instance.get_object_details(root, criteria.localGUID=criteria.localGUID, criteria.cloudGUID=criteria.cloudGUID, criteria.objectType=criteria.objectType, criteria.uniqueIdentifier=criteria.uniqueIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->getObjectDetails: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Query parameters
Name Description
criteria.localGUID
String
criteria.cloudGUID
String
criteria.objectType
String
criteria.uniqueIdentifier
String

Responses

Status: 200 - OK

Get Object List

This object will return list of cloud objects according to search criteria e.g ObjectType/UniqueIdentifier/GUID. 


/YOUR_CONNECTOR_NAME/{root}/Objects/List
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String searchCriteria.localGUID = searchCriteria.localGUID_example; // String | 
        String searchCriteria.cloudGUID = searchCriteria.cloudGUID_example; // String | 
        String searchCriteria.objectType = searchCriteria.objectType_example; // String | 
        String searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example; // String | 
        try {
            ObjectListModel result = apiInstance.getObjectList(root, searchCriteria.localGUID, searchCriteria.cloudGUID, searchCriteria.objectType, searchCriteria.uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#getObjectList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String searchCriteria.localGUID = searchCriteria.localGUID_example; // String | 
        String searchCriteria.cloudGUID = searchCriteria.cloudGUID_example; // String | 
        String searchCriteria.objectType = searchCriteria.objectType_example; // String | 
        String searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example; // String | 
        try {
            ObjectListModel result = apiInstance.getObjectList(root, searchCriteria.localGUID, searchCriteria.cloudGUID, searchCriteria.objectType, searchCriteria.uniqueIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#getObjectList");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
String *searchCriteria.localGUID = searchCriteria.localGUID_example; //  (optional)
String *searchCriteria.cloudGUID = searchCriteria.cloudGUID_example; //  (optional)
String *searchCriteria.objectType = searchCriteria.objectType_example; //  (optional)
String *searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example; //  (optional)

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Get Object List
[apiInstance getObjectListWith:root
    searchCriteria.localGUID:searchCriteria.localGUID
    searchCriteria.cloudGUID:searchCriteria.cloudGUID
    searchCriteria.objectType:searchCriteria.objectType
    searchCriteria.uniqueIdentifier:searchCriteria.uniqueIdentifier
              completionHandler: ^(ObjectListModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var opts = { 
  'searchCriteria.localGUID': searchCriteria.localGUID_example, // {String} 
  'searchCriteria.cloudGUID': searchCriteria.cloudGUID_example, // {String} 
  'searchCriteria.objectType': searchCriteria.objectType_example, // {String} 
  'searchCriteria.uniqueIdentifier': searchCriteria.uniqueIdentifier_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getObjectList(root, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getObjectListExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var searchCriteria.localGUID = searchCriteria.localGUID_example;  // String |  (optional) 
            var searchCriteria.cloudGUID = searchCriteria.cloudGUID_example;  // String |  (optional) 
            var searchCriteria.objectType = searchCriteria.objectType_example;  // String |  (optional) 
            var searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example;  // String |  (optional) 

            try
            {
                // Get Object List
                ObjectListModel result = apiInstance.getObjectList(root, searchCriteria.localGUID, searchCriteria.cloudGUID, searchCriteria.objectType, searchCriteria.uniqueIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.getObjectList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$searchCriteria.localGUID = searchCriteria.localGUID_example; // String | 
$searchCriteria.cloudGUID = searchCriteria.cloudGUID_example; // String | 
$searchCriteria.objectType = searchCriteria.objectType_example; // String | 
$searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example; // String | 

try {
    $result = $api_instance->getObjectList($root, $searchCriteria.localGUID, $searchCriteria.cloudGUID, $searchCriteria.objectType, $searchCriteria.uniqueIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->getObjectList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $searchCriteria.localGUID = searchCriteria.localGUID_example; # String | 
my $searchCriteria.cloudGUID = searchCriteria.cloudGUID_example; # String | 
my $searchCriteria.objectType = searchCriteria.objectType_example; # String | 
my $searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example; # String | 

eval { 
    my $result = $api_instance->getObjectList(root => $root, searchCriteria.localGUID => $searchCriteria.localGUID, searchCriteria.cloudGUID => $searchCriteria.cloudGUID, searchCriteria.objectType => $searchCriteria.objectType, searchCriteria.uniqueIdentifier => $searchCriteria.uniqueIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->getObjectList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
searchCriteria.localGUID = searchCriteria.localGUID_example # String |  (optional)
searchCriteria.cloudGUID = searchCriteria.cloudGUID_example # String |  (optional)
searchCriteria.objectType = searchCriteria.objectType_example # String |  (optional)
searchCriteria.uniqueIdentifier = searchCriteria.uniqueIdentifier_example # String |  (optional)

try: 
    # Get Object List
    api_response = api_instance.get_object_list(root, searchCriteria.localGUID=searchCriteria.localGUID, searchCriteria.cloudGUID=searchCriteria.cloudGUID, searchCriteria.objectType=searchCriteria.objectType, searchCriteria.uniqueIdentifier=searchCriteria.uniqueIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->getObjectList: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Query parameters
Name Description
searchCriteria.localGUID
String
searchCriteria.cloudGUID
String
searchCriteria.objectType
String
searchCriteria.uniqueIdentifier
String

Responses

Status: 200 - OK

Map Object

This endpoint will map object at cloud level.


/YOUR_CONNECTOR_NAME/{root}/Object/Mapping
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        MapObjectModel criteria = ; // MapObjectModel | 
        try {
            ObjectResponseModel result = apiInstance.mapObject(root, criteria);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#mapObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        MapObjectModel criteria = ; // MapObjectModel | 
        try {
            ObjectResponseModel result = apiInstance.mapObject(root, criteria);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#mapObject");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
MapObjectModel *criteria = ; // 

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Map Object
[apiInstance mapObjectWith:root
    criteria:criteria
              completionHandler: ^(ObjectResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var criteria = ; // {MapObjectModel} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mapObject(root, criteria, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class mapObjectExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var criteria = new MapObjectModel(); // MapObjectModel | 

            try
            {
                // Map Object
                ObjectResponseModel result = apiInstance.mapObject(root, criteria);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.mapObject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$criteria = ; // MapObjectModel | 

try {
    $result = $api_instance->mapObject($root, $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->mapObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $criteria = WWW::SwaggerClient::Object::MapObjectModel->new(); # MapObjectModel | 

eval { 
    my $result = $api_instance->mapObject(root => $root, criteria => $criteria);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->mapObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
criteria =  # MapObjectModel | 

try: 
    # Map Object
    api_response = api_instance.map_object(root, criteria)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->mapObject: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Body parameters
Name Description
criteria *

Responses

Status: 200 - OK

Update Object Properties

This endpoint will update properties of object at cloud.


/YOUR_CONNECTOR_NAME/{root}/Object/Update
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        UpdateObjectPropertiesModel userDetails = ; // UpdateObjectPropertiesModel | 
        try {
            StatusModel result = apiInstance.updateObjectProperties(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#updateObjectProperties");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        UpdateObjectPropertiesModel userDetails = ; // UpdateObjectPropertiesModel | 
        try {
            StatusModel result = apiInstance.updateObjectProperties(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#updateObjectProperties");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
UpdateObjectPropertiesModel *userDetails = ; // 

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Update Object Properties
[apiInstance updateObjectPropertiesWith:root
    userDetails:userDetails
              completionHandler: ^(StatusModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var userDetails = ; // {UpdateObjectPropertiesModel} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateObjectProperties(root, userDetails, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateObjectPropertiesExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var userDetails = new UpdateObjectPropertiesModel(); // UpdateObjectPropertiesModel | 

            try
            {
                // Update Object Properties
                StatusModel result = apiInstance.updateObjectProperties(root, userDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.updateObjectProperties: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$userDetails = ; // UpdateObjectPropertiesModel | 

try {
    $result = $api_instance->updateObjectProperties($root, $userDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->updateObjectProperties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $userDetails = WWW::SwaggerClient::Object::UpdateObjectPropertiesModel->new(); # UpdateObjectPropertiesModel | 

eval { 
    my $result = $api_instance->updateObjectProperties(root => $root, userDetails => $userDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->updateObjectProperties: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
userDetails =  # UpdateObjectPropertiesModel | 

try: 
    # Update Object Properties
    api_response = api_instance.update_object_properties(root, userDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->updateObjectProperties: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Body parameters
Name Description
userDetails *

Responses

Status: 200 - OK

Update User Password

This endpoint will update user password at cloud.


/YOUR_CONNECTOR_NAME/{root}/User/Update-Password
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        UpdateUserPasswordModel userDetails = ; // UpdateUserPasswordModel | 
        try {
            StatusModel result = apiInstance.updateUserPassword(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        UpdateUserPasswordModel userDetails = ; // UpdateUserPasswordModel | 
        try {
            StatusModel result = apiInstance.updateUserPassword(root, userDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#updateUserPassword");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
UpdateUserPasswordModel *userDetails = ; // 

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Update User Password
[apiInstance updateUserPasswordWith:root
    userDetails:userDetails
              completionHandler: ^(StatusModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var userDetails = ; // {UpdateUserPasswordModel} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserPassword(root, userDetails, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateUserPasswordExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var userDetails = new UpdateUserPasswordModel(); // UpdateUserPasswordModel | 

            try
            {
                // Update User Password
                StatusModel result = apiInstance.updateUserPassword(root, userDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.updateUserPassword: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$userDetails = ; // UpdateUserPasswordModel | 

try {
    $result = $api_instance->updateUserPassword($root, $userDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->updateUserPassword: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $userDetails = WWW::SwaggerClient::Object::UpdateUserPasswordModel->new(); # UpdateUserPasswordModel | 

eval { 
    my $result = $api_instance->updateUserPassword(root => $root, userDetails => $userDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->updateUserPassword: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
userDetails =  # UpdateUserPasswordModel | 

try: 
    # Update User Password
    api_response = api_instance.update_user_password(root, userDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->updateUserPassword: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Body parameters
Name Description
userDetails *

Responses

Status: 200 - OK

Delete Object

This endpoint will delete object from cloud.


/YOUR_CONNECTOR_NAME/{root}/Object/Delete
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ActiveDirectoryApi;

import java.io.File;
import java.util.*;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String criteria.localGUID = criteria.localGUID_example; // String | 
        String criteria.objectType = criteria.objectType_example; // String | 
        try {
            StatusModel result = apiInstance.deleteObject(root, criteria.localGUID, criteria.objectType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#deleteObject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ActiveDirectoryApi;

public class ActiveDirectoryApiExample {

    public static void main(String[] args) {
        ActiveDirectoryApi apiInstance = new ActiveDirectoryApi();
        String root = root_example; // String | 
        String criteria.localGUID = criteria.localGUID_example; // String | 
        String criteria.objectType = criteria.objectType_example; // String | 
        try {
            StatusModel result = apiInstance.deleteObject(root, criteria.localGUID, criteria.objectType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActiveDirectoryApi#deleteObject");
            e.printStackTrace();
        }
    }
}
String *root = root_example; // 
String *criteria.localGUID = criteria.localGUID_example; // 
String *criteria.objectType = criteria.objectType_example; //  (optional)

ActiveDirectoryApi *apiInstance = [[ActiveDirectoryApi alloc] init];

// Delete Object
[apiInstance deleteObjectWith:root
    criteria.localGUID:criteria.localGUID
    criteria.objectType:criteria.objectType
              completionHandler: ^(StatusModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AdConnectSyncConnectors = require('ad_connect_sync_connectors');

var api = new AdConnectSyncConnectors.ActiveDirectoryApi()

var root = root_example; // {String} 

var criteria.localGUID = criteria.localGUID_example; // {String} 

var opts = { 
  'criteria.objectType': criteria.objectType_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteObject(root, criteria.localGUID, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteObjectExample
    {
        public void main()
        {
            
            var apiInstance = new ActiveDirectoryApi();
            var root = root_example;  // String | 
            var criteria.localGUID = criteria.localGUID_example;  // String | 
            var criteria.objectType = criteria.objectType_example;  // String |  (optional) 

            try
            {
                // Delete Object
                StatusModel result = apiInstance.deleteObject(root, criteria.localGUID, criteria.objectType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ActiveDirectoryApi.deleteObject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ActiveDirectoryApi();
$root = root_example; // String | 
$criteria.localGUID = criteria.localGUID_example; // String | 
$criteria.objectType = criteria.objectType_example; // String | 

try {
    $result = $api_instance->deleteObject($root, $criteria.localGUID, $criteria.objectType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActiveDirectoryApi->deleteObject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ActiveDirectoryApi;

my $api_instance = WWW::SwaggerClient::ActiveDirectoryApi->new();
my $root = root_example; # String | 
my $criteria.localGUID = criteria.localGUID_example; # String | 
my $criteria.objectType = criteria.objectType_example; # String | 

eval { 
    my $result = $api_instance->deleteObject(root => $root, criteria.localGUID => $criteria.localGUID, criteria.objectType => $criteria.objectType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActiveDirectoryApi->deleteObject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ActiveDirectoryApi()
root = root_example # String | 
criteria.localGUID = criteria.localGUID_example # String | 
criteria.objectType = criteria.objectType_example # String |  (optional)

try: 
    # Delete Object
    api_response = api_instance.delete_object(root, criteria.localGUID, criteria.objectType=criteria.objectType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActiveDirectoryApi->deleteObject: %s\n" % e)

Parameters

Path parameters
Name Description
root*
String
Required
Query parameters
Name Description
criteria.localGUID*
String
Required
criteria.objectType
String

Responses

Status: 200 - OK