C# Class Rally.RestApi.UiForWinforms.RestApiAuthMgrWinforms

A Winforms based authentication manager.

Inheritance: Rally.RestApi.Auth.ApiAuthManager

Public Methods

Method	Description
RestApiAuthMgrWinforms ( string applicationToken, string encryptionKey, IEncryptionRoutines encryptionRoutines, string webServiceVersion = RallyRestApi.DEFAULT_WSAPI_VERSION, TraceFieldEnum traceInfo = RallyRestApi.DEFAULT_TRACE_FIELDS ) : Rally.RestApi.Auth	Constructor
SetLogo ( Image logo ) : void	Sets the logo used in the user controls.

Method	Description
NotifyLoginWindowSsoComplete ( RallyRestApi authenticationResult, RallyRestApi api ) : void	Notifies the login window that SSO has been completed.
OpenSsoPageInternal ( Uri ssoUrl ) : void	Opens the specified SSO URL to the user.
ShowUserLoginWindowInternal ( ) : void	Opens the window that displays the SSO URL to the user.

Method	Description
PerformAuthenticationCheck ( string &errorMessage ) : RallyRestApi.AuthenticationResult	Performs an authentication check against Rally with the specified credentials
PerformLogout ( ) : void	Performs an logout from Rally.
ReportSsoResultsToMgr ( bool success, string rallyServer, string zSessionID ) : void	Reports the results of an SSO action.
loginControl_Closed ( object sender, EventArgs e ) : void

Notifies the login window that SSO has been completed.

protected NotifyLoginWindowSsoComplete ( RallyRestApi authenticationResult, RallyRestApi api ) : void
authenticationResult	RallyRestApi	The current state of the authentication process.
api	RallyRestApi	The API that was authenticated against.
return	void

Opens the specified SSO URL to the user.

protected OpenSsoPageInternal ( Uri ssoUrl ) : void
ssoUrl	System.Uri	The Uri that the user was redirected to in order to perform their SSO authentication.
return	void

Constructor

public RestApiAuthMgrWinforms ( string applicationToken, string encryptionKey, IEncryptionRoutines encryptionRoutines, string webServiceVersion = RallyRestApi.DEFAULT_WSAPI_VERSION, TraceFieldEnum traceInfo = RallyRestApi.DEFAULT_TRACE_FIELDS ) : Rally.RestApi.Auth
applicationToken	string	An application token to be used as the file name to store data as. Each /// consuming application should use a unique name in order to ensure that the user credentials are not /// overwritten by other applications.
encryptionKey	string	The encryption key, or salt, to be used for any encryption routines. This salt /// should be different for each user, and not the same for everyone consuming the same application. Only used /// for UI support.
encryptionRoutines	IEncryptionRoutines	The encryption routines to use for encryption/decryption of data. Only used for UI support.
webServiceVersion	string	The version of the WSAPI API to use.
traceInfo	TraceFieldEnum	Controls diagnostic trace information being logged
return	Rally.RestApi.Auth

Sets the logo used in the user controls.

public static SetLogo ( Image logo ) : void
logo	Image	The image to use as a logo.
return	void

Opens the window that displays the SSO URL to the user.

protected ShowUserLoginWindowInternal ( ) : void
return	void