Cloud Connector API
version 3.5.1001.64485
API for managing and configuring the Cloud Connector
|
Context for sending DirSync specific actions to the connector service. More...
Public Member Functions | |
void | OverrideDeleteThreshold () |
Sends a command to to indicate that the next synchronization should override the delete threshold if it has been reached. More... | |
IDirSyncConfiguration | GetConfiguration () |
Retrieves the configuration for the organization. More... | |
void | SetConfiguration (IDirSyncConfiguration configuration) |
Updates the configuration for the organization. More... | |
IDryRunManager | CreateDryRunManager (ISyncDomain syncDomain) |
Creates a IDryRunManager to allow for testing the provided ISyncDomain in synchronizing directory information on-premise to the cloud. More... | |
IList< ISyncDomain > | GetDomains () |
Receive the domain names existing in cloud More... | |
void | Bind (ISyncDomain domain, bool newBinding) |
Bind domain for the connector More... | |
void | SetDomainPriority (ISyncDomain[] domains) |
Set domain priority for multiple domain case More... | |
ISyncControl | GetSyncControl () |
Get specific sync control flag More... | |
void | SetSyncControl (ISyncControl syncControl) |
Set specific sync control flag More... | |
IAttrExprVerificationResult | VerifyAttrExpr (string expression) |
Verify the attribute expression More... | |
IAttrExprSampleResult | SamplingAttrExpr (string expression, IDictionary< string, string > props) |
Get the expression sample result More... | |
IAttributeExprMetaData | GetAttrExprMeta () |
Get the attribute expression opeartor and function detail information More... | |
void | SetInfoLogsToCloud (HashSet< string > logMsgs) |
Send logs to cloud More... | |
![]() | |
void | SendServiceCommand (Command command) |
Sends a command to the connector service. More... | |
void | SetServiceMode (Mode mode) |
Set (change) the service mode. This allows you to enable, disable or pause the connector service. More... | |
void | RegisterConnector (ISyncDomain boundDomain) |
Register a Cloud Connector for the service type on this computer. This will "bind" the Connector to the current organization if it isn't already bound. The connector cannot be bound to a different organization. More... | |
bool | IsConnectorRegistered () |
Test to see if the connector is registered or not. More... | |
void | UnregisterConnector () |
Un-register a Cloud Connector for the service type from this computer. More... | |
void | UnregisterConnector (byte[] connectorGuid) |
Un-register a Cloud Connector for the service type from a different computer. More... | |
void | ResetConnectorSecret () |
Manually reset the userid/secret used by the Cloud Connector Windows service. More... | |
IServiceInformation | GetServiceInformation () |
Retrieves the service information for the organization. More... | |
void | SaveConnectorServiceUri (string uri) |
Save connector service uri. More... | |
Context for sending DirSync specific actions to the connector service.
void Bind | ( | ISyncDomain | domain, |
bool | newBinding | ||
) |
Bind domain for the connector
domain | sync domain< |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Set configuration failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
NoSuchDomainException | Domain does not exist in cloud |
Exception | Other exceptions may also be thrown by the platform and operating system |
IDryRunManager CreateDryRunManager | ( | ISyncDomain | syncDomain | ) |
Creates a IDryRunManager to allow for testing the provided ISyncDomain in synchronizing directory information on-premise to the cloud.
syncDomain | ISyncDomain to try the dry run. |
IAttributeExprMetaData GetAttrExprMeta | ( | ) |
Get the attribute expression opeartor and function detail information
IDirSyncConfiguration GetConfiguration | ( | ) |
Retrieves the configuration for the organization.
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Get configuration failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
IList<ISyncDomain> GetDomains | ( | ) |
Receive the domain names existing in cloud
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Set configuration failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
ISyncControl GetSyncControl | ( | ) |
Get specific sync control flag
void OverrideDeleteThreshold | ( | ) |
Sends a command to to indicate that the next synchronization should override the delete threshold if it has been reached.
See IDirSyncConfiguration.DeleteThreshold See IDirSyncEventInformation
IAttrExprSampleResult SamplingAttrExpr | ( | string | expression, |
IDictionary< string, string > | props | ||
) |
Get the expression sample result
expression | |
props |
void SetConfiguration | ( | IDirSyncConfiguration | configuration | ) |
Updates the configuration for the organization.
configuration | Configuration to set (previously retrieved using GetConfiguration) |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Set configuration failed |
NoSuchOrganizationException | The organization does not exist |
SessionExpiredException | The session to the Connector Service has expired |
ServiceException | Unspecified service error |
Exception | Other exceptions may also be thrown by the platform and operating system |
void SetDomainPriority | ( | ISyncDomain[] | domains | ) |
Set domain priority for multiple domain case
domains |
void SetInfoLogsToCloud | ( | HashSet< string > | logMsgs | ) |
Send logs to cloud
logMsgs |
void SetSyncControl | ( | ISyncControl | syncControl | ) |
Set specific sync control flag
syncControl |
IAttrExprVerificationResult VerifyAttrExpr | ( | string | expression | ) |
Verify the attribute expression
expression |