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

This represents a session with the Connector Service. More...

Inherits IDisposable.

Inherited by ConnectorSession.

Public Member Functions

void Reset (string orgId)
 Rest the ConnectorURI to the one with OrgId More...
 
IDirSyncContext GetDirSyncContext ()
 Return a service specific context for sending commands/actions to the DirSync service. More...
 
IList< IOrganizationGetOrganizations ()
 Retrieves a list of organizations that the logged in user has permissions to manage. More...
 
void Logout ()
 Logout the session to the Connector Service. More...
 
void SSOLogin (string token, string cookieHeader)
 Login to the Connector service using the token from SSO. More...
 
string OAuthCodeLogin (string code, string cookieHeader)
 Login to the Connector service using the code from grant_type=code More...
 
void Login (string userid, string password)
 Login to the Connector service using CoDev More...
 
void Login (string userid, byte[] secret)
 Login to the Connector service using CoDev More...
 

Properties

byte[] OrgId [get, set]
 Gets or sets the organization to use for this session. Will automatically be read from the local config if it exists. (Setting it will not cause a configuration write.) If it is not set in the config, and if the login is associated with exactly one organization that organization will be used. More...
 
bool IsTerminated [get]
 Gets a value indicating whether this session has been terminated, either via logout or an exception that caused the server to drop the connection. More...
 
bool IsFederatedSSO [get]
 Gets a value indicating whether this session should use Single Sign On (SSO) for authenticating the user. More...
 
string SSOCookieName [get]
 Gets a value for the cookie name to look for when doing SSO More...
 
string SSORedirectURL [get]
 Gets a value for the URL to be used for SSO More...
 
string SLORedirectURL [get]
 Gets a value for the URL to be used for SLO More...
 
string GlobalSSORedirectURL [get]
 Gets a value for the URL to be used for GLOBAL LOGIN More...
 
string AuthorizationCodeURL [get]
 Gets a value for the Authorization Code URL to be used for GLOBAL LOGIN More...
 
string AuthorizationCodeURLWithOrg [get]
 Gets a value for the Authorization Code URL to be used for SSO LOGIN More...
 
string ScimMeURL [get]
 Gets a value for the URL to be used for calling the SCIM/V1/Users/Me API More...
 
string UserName [get]
 Gets a value for the user that is logged in More...
 

Detailed Description

This represents a session with the Connector Service.

The session is not bound to a specific service type.

Member Function Documentation

IDirSyncContext GetDirSyncContext ( )

Return a service specific context for sending commands/actions to the DirSync service.

Returns
Context for managing the DirSync service
IList<IOrganization> GetOrganizations ( )

Retrieves a list of organizations that the logged in user has permissions to manage.

Often this will only return a single organization.

Returns
List of organizations
void Login ( string  userid,
string  password 
)

Login to the Connector service using CoDev

Parameters
useridThe user OD
passwordThe password
void Login ( string  userid,
byte[]  secret 
)

Login to the Connector service using CoDev

Parameters
useridThe user ID
secretThe password
void Logout ( )

Logout the session to the Connector Service.

string OAuthCodeLogin ( string  code,
string  cookieHeader 
)

Login to the Connector service using the code from grant_type=code

Parameters
tokenThe token from Single Sign On
cookieHeaderThe cookie header from Single Sign On
void Reset ( string  orgId)

Rest the ConnectorURI to the one with OrgId

void SSOLogin ( string  token,
string  cookieHeader 
)

Login to the Connector service using the token from SSO.

Parameters
tokenThe token from Single Sign On
cookieHeaderThe cookie header from Single Sign On

Property Documentation

string AuthorizationCodeURL
get

Gets a value for the Authorization Code URL to be used for GLOBAL LOGIN

string AuthorizationCodeURLWithOrg
get

Gets a value for the Authorization Code URL to be used for SSO LOGIN

string GlobalSSORedirectURL
get

Gets a value for the URL to be used for GLOBAL LOGIN

bool IsFederatedSSO
get

Gets a value indicating whether this session should use Single Sign On (SSO) for authenticating the user.

bool IsTerminated
get

Gets a value indicating whether this session has been terminated, either via logout or an exception that caused the server to drop the connection.

byte [] OrgId
getset

Gets or sets the organization to use for this session. Will automatically be read from the local config if it exists. (Setting it will not cause a configuration write.) If it is not set in the config, and if the login is associated with exactly one organization that organization will be used.

string ScimMeURL
get

Gets a value for the URL to be used for calling the SCIM/V1/Users/Me API

string SLORedirectURL
get

Gets a value for the URL to be used for SLO

string SSOCookieName
get

Gets a value for the cookie name to look for when doing SSO

string SSORedirectURL
get

Gets a value for the URL to be used for SSO

string UserName
get

Gets a value for the user that is logged in


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