| RestApiAuthMgrWpf Class |
A WPF based authentication manager.
Inheritance Hierarchy
Namespace: Rally.RestApi.UiForWpf
Assembly: Rally.RestApi.UiForWpf (in Rally.RestApi.UiForWpf.dll) Version: 3.1.1.0 (3.1.1.0)
SyntaxThe RestApiAuthMgrWpf type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | RestApiAuthMgrWpf |
Constructor
|
Properties| Name | Description | |
|---|---|---|
  | AllowIdpBasedSso |
Should IDP Based SSO be allowed? This is known to have quite a few JavaScript
errors and is therefore defaulted to off.
|
| Api |
The API that is linked to this authorization manager.
(Inherited from ApiAuthManager.) |
 | AuthenticationStateChange |
Notifies that SSO authentication has completed.
(Inherited from ApiAuthManager.) |
| IsUiSupported |
Is the UI supported?
(Inherited from ApiAuthManager.) |
| LoginDetails |
The details for the user who is logging in using this auth manager.
(Inherited from ApiAuthManager.) |
| SsoAuthenticationComplete |
Notifies that SSO authentication has completed.
(Inherited from ApiAuthManager.) |
Methods| Name | Description | |
|---|---|---|
| AutoAuthenticate |
Auto authenticates the user if there are saved credentials.
(Inherited from ApiAuthManager.) |
| DeleteCachedLoginDetailsFromDisk |
Deletes any cached login credentials from disk.
(Inherited from ApiAuthManager.) |
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NotifyLoginWindowSsoComplete |
Notifies the login window that SSO has been completed.
(Overrides ApiAuthManagerNotifyLoginWindowSsoComplete(RallyRestApiAuthenticationResult, RallyRestApi).) |
| OpenSsoPageInternal |
Opens the specified SSO URL to the user.
(Overrides ApiAuthManagerOpenSsoPageInternal(Uri).) |
| PerformAuthenticationCheck |
Performs an authentication check against an identity provider (IDP Initiated).
(Inherited from ApiAuthManager.) |
| PerformLogoutFromRally |
Performs an logout from Rally.
(Inherited from ApiAuthManager.) |
| ReportSsoResults |
Reports the results of an SSO action.
(Inherited from ApiAuthManager.) |
| SetCustomControlType |
Sets a custom control for the specified control type. Please see the
enumeration help for what the types must extend from in order to work.
|
| SetLogo |
Sets the logo used in the user controls.
|
| ShowUserLoginWindow |
Authenticates the user against Rally. This must be called from the UI thread.
(Inherited from ApiAuthManager.) |
| ShowUserLoginWindowInternal |
Opens the window that displays the SSO URL to the user.
(Overrides ApiAuthManagerShowUserLoginWindowInternal.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | WindowStateChanged |
An event that notifies when a window has changed state.
You will need to listen to this event if you need to notify your parent application that you have windows open, such as if you are developing an Office plug-in and need to set the application interactive mode. bool isWindowOpen;
Globals.ThisAddIn.Application.Interactive = isWindowOpen; |
See Also