Cloud Connector API
version 3.5.1001.64485
API for managing and configuring the Cloud Connector
|
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... | |
This interface is used for creating sessions to the Connector Service.
IConnectorSession CreateSession | ( | string | emailHash | ) |
Creates a session to the Connector Service.
If any failure occurs an exception will be thrown.
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Login failed, for example invalid username/password |
NoSuchOrganizationException | The organization does not exist |
ServiceException | Unspecified service error |
Exception | Other 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.
userid | Username for authenticating to the Connector Service |
password | Password for authenticating to the Connector Service |
PermissionDeniedException | The user does not have enough permissions |
ServiceFailureException | Login failed, for example invalid username/password |
NoSuchOrganizationException | The organization does not exist |
ServiceException | Unspecified service error |
Exception | Other 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.
userid | Username for authenticating to the Connector Service |
secret | Binary secret for authenticating 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
void ResetConfig | ( | ) |
Reset configuration to default.
void RestConfigServiceUri | ( | Uri | uri | ) |
save the uri into Config file
|
get |
Gets the id of the local Cloud Connector.
|
getset |
Gets or sets the URL for connecting to the Connector Service.