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.
IDirSyncContext	GetDirSyncContext ()
	Return a service specific context for sending commands/actions to the DirSync service.
IList< IOrganization >	GetOrganizations ()
	Retrieves a list of organizations that the logged in user has permissions to manage.
void	Logout ()
	Logout the session to the Connector Service.
void	SSOLogin (string token, string cookieHeader)
	Login to the Connector service using the token from SSO.
string	OAuthCodeLogin (string code, string cookieHeader)
	Login to the Connector service using the code from grant_type=code.
void	Login (string userid, string password)
	Login to the Connector service using CoDev.
void	Login (string userid, byte[] secret)
	Login to the Connector service using CoDev.

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.
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.
bool	IsFederatedSSO [get]
	Gets a value indicating whether this session should use Single Sign On (SSO) for authenticating the user.
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	SLORedirectURL [get]
	Gets a value for the URL to be used for SLO.
string	GlobalSSORedirectURL [get]
	Gets a value for the URL to be used for GLOBAL LOGIN.
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	ScimMeURL [get]
	Gets a value for the URL to be used for calling the SCIM/V1/Users/Me API.
string	UserName [get]
	Gets a value for the user that is logged in.

Detailed Description

This represents a session with the Connector Service.

The session is not bound to a specific service type.

Member Function Documentation

GetDirSyncContext()

IDirSyncContext GetDirSyncContext

(

)

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

Returns

Context for managing the DirSync service

GetOrganizations()

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

Login() [1/2]

void Login	(	string	userid,
		byte[]	secret )

Login to the Connector service using CoDev.

Parameters

userid	The user ID
secret	The password

Login() [2/2]

void Login	(	string	userid,
		string	password )

Login to the Connector service using CoDev.

Parameters

userid	The user OD
password	The password

OAuthCodeLogin()

string OAuthCodeLogin	(	string	code,
		string	cookieHeader )

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

Parameters

token	The token from Single Sign On
cookieHeader	The cookie header from Single Sign On

SSOLogin()

void SSOLogin	(	string	token,
		string	cookieHeader )

Login to the Connector service using the token from SSO.

Parameters

token	The token from Single Sign On
cookieHeader	The cookie header from Single Sign On

---

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

• IConnectorSession.cs