Cloud Connector API version 3.8.7000.64800
API for managing and configuring the Cloud Connector
Loading...
Searching...
No Matches
Cisco.CoDev.Identity.ConnectorService.Management Namespace Reference

Classes

class  CIClusterMismatchExecption
 CI Cluster Mismatch. More...
 
class  ConnectorManagerFactory
 This is the factory class for creating Connector managers. More...
 
class  DirSyncServiceCodeConstants
 Class holding constants for ServiceCode within IReturnInformation. More...
 
interface  IAttributeMapping
 List of mappings between on-premises and in-cloud attributes for an object type. More...
 
interface  IConnectorManager
 This interface is used for creating sessions to the Connector Service. More...
 
interface  IConnectorSession
 This represents a session with the Connector Service. More...
 
interface  IConnectorStatus
 Interface to represent the detailed connector status information. More...
 
interface  IConnectorType
 This represents a registered connector. More...
 
interface  IDirSyncConfiguration
 Configuration data that is specific for the directory synchronization service. More...
 
interface  IDirSyncConnectorConfiguration
 Connector specific configuration. More...
 
interface  IDirSyncContext
 Context for sending DirSync specific actions to the connector service. More...
 
interface  IDirSyncDomainStatistics
 Interface representing the DirSync specific statistics found within a service's information. More...
 
interface  IDirSyncEventInformation
 Interface for representing event information received from the connector specific to DirSync. See IServiceInformation and IEventInformation for further information. More...
 
interface  IDomainSyncPolicy
 The policy specifies which objects are synchronized. More...
 
interface  IEventInformation
 Interface for representing event information received from the connector. See IServiceInformation for further information. More...
 
interface  IEventState
 Interface for representing the event state for event information. See IEventInformation for further information. More...
 
interface  IHost
 Directory host information. More...
 
interface  IIssuer
 Interface for representing the issuer for event information. See IEventInformation for further information. More...
 
interface  IMapping
 Mapping between an on-premises and in-cloud attribute. More...
 
interface  INextSchedule
 Interface for representing the next schedule for service information. See IServiceInformation for further information. More...
 
interface  IObjectCount
 Interface representing a generic count for a given object type used in statistics gathering. See IStatistics and IDirSyncDomainStatistics for more information. More...
 
interface  IObjectSelectionCriteria
 Criteria for selecting objects. More...
 
interface  IOrganization
 An organization is a boundary for identity data. More...
 
interface  IReturnInformation
 Interface for representing the return information. See IEventInformation for further information. More...
 
interface  IServiceConfiguration
 Configuration that is common for all service types. More...
 
interface  IServiceContext
 Context for sending actions to the connector service for a service type. More...
 
interface  IServiceInformation
 Interface representing the service information. This can be used to determine the state of the service. More...
 
interface  IStatistics
 Interface representing the statistics found within a service's information. More...
 
interface  ISyncControl
 Sync control to determine sync policy. More...
 
interface  ISyncDomain
 On-premises domains that are being synchronized. More...
 
class  NoSuchCIClusterExecption
 No Such CI Cluster. More...
 
class  NoSuchConnectorException
 Can't find connector in cloud. More...
 
class  NoSuchDomainException
 Can't find the binded domain in cloud. More...
 
class  NoSuchOrganizationException
 The organization cannot be found. More...
 
class  PermissionDeniedException
 Permission Denied - The user does not have enough permissions. More...
 
class  ServiceException
 General Connector Service exception. More...
 
class  ServiceFailureException
 Connector Service Failure, i.e. action failed. More...
 
class  SessionExpiredException
 The session to the Connector Service has expired. More...
 
class  UnsupportedVersionException
 The client software is not supported. More...
 

Enumerations

enum  Status {
  FailedAuthentication , MissedMultipleTimes , MissedOnce , NeverConnected ,
  Normal
}
 Enumeration of the different types of status for the connector. More...
 
enum  EventType { FullSync , IncrementalSync }
 Enumeration of the different event types contained within the event information. More...
 
enum  IssuerType { Administrator , System }
 Enumeration for the types of Issuers. See IIssuer for further information. More...
 
enum  ReturnCode {
  Success , SuccessWithErrors , SuccessWithWarnings , Failure ,
  OperationInProgress , PermissionDenied , SessionExpired , NoSuchOrganization ,
  ServiceUnavailable , UnknownMessageType , NoSuchTask , TaskTypeMismatch ,
  ProtocolError , Ack , IllegalArgument , NotSupported ,
  More , Deprecated , ServiceSpecificReturn , Abandoned ,
  Aborted , Scheduled , UnsupportedByApi
}
 Enumeration of return codes. More...
 
enum  LogLevel
 Log level for the on-premises Cloud Connector.
 
enum  ServiceType { DirSync }
 Service type, i.e. type of Cloud Connector. More...
 
enum  Command { FullSync , IncrementalSync , CustomizeSync }
 Commands that can be sent to the service. More...
 
enum  Mode { Enabled , Disabled , Paused }
 Service Mode. More...
 
enum  CustomizeSyncScope { All , Dirsync }
 Customize Sync Scope. More...
 
enum  CustomizeSyncCommandType { DeleteAvatar , OverrideAvatar , DeleteAndOverrideAvatar , DeleteSpecifiedAttribute }
 
enum  IdentityStoreType { Unknown , ActiveDirectory , ADDS , ADLDS }
 Identity store types. More...
 

Enumeration Type Documentation

◆ Command

enum Command

Commands that can be sent to the service.

Enumerator
FullSync 

Start a full synchronization.

IncrementalSync 

Start an incremental synchronization.

CustomizeSync 

Start an customize synchronization.

◆ CustomizeSyncCommandType

Enumerator
DeleteAvatar 

DeleteAvatar.

OverrideAvatar 

OverrideAvatar.

DeleteAndOverrideAvatar 

DeleteAndOverrideAvatar.

DeleteSpecifiedAttribute 

DeleteSpecifiedAttribute.

◆ CustomizeSyncScope

Customize Sync Scope.

Enumerator
All 

All.

Dirsync 

DirSync.

◆ EventType

enum EventType

Enumeration of the different event types contained within the event information.

IEventInformation

Enumerator
FullSync 

Event type representing a Full Synchronization event.

IncrementalSync 

Event type representing an Incremental Synchronization event.

◆ IdentityStoreType

Identity store types.

Enumerator
Unknown 

Unknown store type.

ActiveDirectory 

Active Directory.

ADDS 

Active Directory Domain Service.

ADLDS 

Active Directory Lightweight Directory Service.

◆ IssuerType

enum IssuerType

Enumeration for the types of Issuers. See IIssuer for further information.

Enumerator
Administrator 

Issuer is an administrator.

System 

Issuer is the system.

◆ Mode

enum Mode

Service Mode.

Enumerator
Enabled 

Enable connector service.

Disabled 

Disable connector service.

Paused 

Pause connector service.

◆ ReturnCode

enum ReturnCode

Enumeration of return codes.

Enumerator
Success 

Indicates that the associated request was successfully handled.

SuccessWithErrors 

Indicates that the associated request was mostly successful but encountered errors.

SuccessWithWarnings 

Indicates that the associated request was mostly successful but encountered warning.

Failure 

Indicates that the associated request failed.

OperationInProgress 

Operation currently in progress.

PermissionDenied 

Permission denied.

SessionExpired 

Session expired.

NoSuchOrganization 

No such organization.

ServiceUnavailable 

Service Unavailable.

UnknownMessageType 

Unknown message type.

NoSuchTask 

No such task.

TaskTypeMismatch 

Task type mismatch.

ProtocolError 

Indicates that the associated request resulted in a protocol error.

Ack 

Used to acknowledge the receipt of a message by an endpoint.

IllegalArgument 

Indicates that the associated request was given an illegal argument.

NotSupported 

Indicates that the associated request is not supported.

More 

Used to indicate that more information needs to be transferred to an endpoint.

Deprecated 

Indicates that the associated request is deprecated.

ServiceSpecificReturn 

Indicates that a service specific return code must be consulted.

Abandoned 

Indicates that the associated request has been abandoned.

Aborted 

Indicates that the associated request has been abandoned aborted.

Scheduled 

Indicates that the associated request has been scheduled.

UnsupportedByApi 

Indicates that the associated request has a return code not supported by the API.

◆ ServiceType

Service type, i.e. type of Cloud Connector.

Enumerator
DirSync 

Directory Synchronization.

◆ Status

enum Status

Enumeration of the different types of status for the connector.

Enumerator
FailedAuthentication 

Status representing when the connector has failed authentication.

MissedMultipleTimes 

Status representing when the connector has missed multiple times connecting to the cloud.

MissedOnce 

Status representing when the connector has missed multiple one time connecting to the cloud.

NeverConnected 

Status representing when the connector has never connected.

Normal 

Status representing when the connector is in a normal state.