Cloud Connector API  version 3.5.1001.64485
API for managing and configuring the Cloud Connector
IConnectorManager Interface Reference

This interface is used for creating sessions to the Connector Service. More...

Inherited by ConnectorManager.

Public Member Functions

IConnectorSession Login (string userid, string password)
 Creates a session to the Connector Service and logs in. More...
 
IConnectorSession Login (string userid, byte[] secret)
 Creates a session to the Connector Service and logs in using a binary secret instead of a password. More...
 
IConnectorSession CreateSession (string emailHash)
 Creates a session to the Connector Service. More...
 
bool NeedGlobalLogin ()
 Check If the ConnectorServiceURI in CiscoConnectorCommon.dll.config is end of "GLOBAL" More...
 
void RestConfigServiceUri (Uri uri)
 save the uri into Config file More...
 
void ResetConfig ()
 Reset configuration to default. More...
 

Properties

Uri ServiceUri [get, set]
 Gets or sets the URL for connecting to the Connector Service. More...
 
byte[] ConnectorId [get]
 Gets the id of the local Cloud Connector. More...
 

Detailed Description

This interface is used for creating sessions to the Connector Service.

Member Function Documentation

IConnectorSession CreateSession ( string  emailHash)

Creates a session to the Connector Service.

If any failure occurs an exception will be thrown.

Returns
A session to the Connector Service
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionLogin failed, for example invalid username/password
NoSuchOrganizationExceptionThe organization does not exist
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
IConnectorSession Login ( string  userid,
string  password 
)

Creates a session to the Connector Service and logs in.

If any failure occurs, i.e. login fails, an exception will be thrown. This function has been deprecated in version 2.0 of the API.

Parameters
useridUsername for authenticating to the Connector Service
passwordPassword for authenticating to the Connector Service
Returns
Authenticated session to the Connector Service
Exceptions
PermissionDeniedExceptionThe user does not have enough permissions
ServiceFailureExceptionLogin failed, for example invalid username/password
NoSuchOrganizationExceptionThe organization does not exist
ServiceExceptionUnspecified service error
ExceptionOther exceptions may also be thrown by the platform and operating system
IConnectorSession Login ( string  userid,
byte[]  secret 
)

Creates a session to the Connector Service and logs in using a binary secret instead of a password.

What this binary secret is depends on the Authentication SPI implementaion of the Connector Service. The same exceptions are thrown for this method as the Login(string,string) method.

Parameters
useridUsername for authenticating to the Connector Service
secretBinary secret for authenticating to the Connector Service
Returns
Authenticated session to the Connector Service
bool NeedGlobalLogin ( )

Check If the ConnectorServiceURI in CiscoConnectorCommon.dll.config is end of "GLOBAL"

MAC US 14975 FIXME this should not be an API

Returns
if the ConnectorServiceURI is NULL, return false return if the ConnectorServiceURI is end of "GLOBAL"
void ResetConfig ( )

Reset configuration to default.

void RestConfigServiceUri ( Uri  uri)

save the uri into Config file

Property Documentation

byte [] ConnectorId
get

Gets the id of the local Cloud Connector.

Uri ServiceUri
getset

Gets or sets the URL for connecting to the Connector Service.


The documentation for this interface was generated from the following file: