| ApiAuthManager Class |
A authentication manager for a manually implemented authentication.
Inheritance Hierarchy
SystemObject
Rally.RestApi.AuthApiAuthManager
Rally.RestApi.AuthApiConsoleAuthManager
Rally.RestApi.UiForWinformsRestApiAuthMgrWinforms
Rally.RestApi.UiForWpfRestApiAuthMgrWpf
Rally.RestApi.AuthApiAuthManager
Rally.RestApi.AuthApiConsoleAuthManager
Rally.RestApi.UiForWinformsRestApiAuthMgrWinforms
Rally.RestApi.UiForWpfRestApiAuthMgrWpf
Namespace: Rally.RestApi.Auth
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
SyntaxThe ApiAuthManager type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ApiAuthManager |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | Api |
The API that is linked to this authorization manager.
|
 | AuthenticationStateChange |
Notifies that SSO authentication has completed.
|
| IsUiSupported |
Is the UI supported?
|
| LoginDetails |
The details for the user who is logging in using this auth manager.
|
 | LoginFailureBadConnection |
The error message to show when we failed to connect to a server or proxy.
|
| LoginFailureBadServer |
The error message to show when a login failure occured due to the server not being reachable.
|
| LoginFailureCredentials |
The error message to show when a login failure occured due to bad credentials.
|
| LoginFailureLoginEmpty |
The error message to show when a login failure occured due to the credentials being empty.
|
| LoginFailureProxyCredentials |
The error message to show when a login failure occured due to bad proxy credentials.
|
| LoginFailureServerEmpty |
The error message to show when a login failure occured due to the server field being empty.
|
| LoginFailureUnknown |
The error message to show when an unknown login failure occured.
|
| LoginWindowCancelText |
The text for the cancel button in the login window.
|
| LoginWindowConnectionTypeText |
The text for the connection type label in the login window.
|
| LoginWindowCredentialsTabText |
The text for the credentials tab in the login window.
|
| LoginWindowDefaultProxyServer |
The default proxy server for the login window.
|
| LoginWindowDefaultServer |
The default server for the login window.
|
| LoginWindowHeaderLabelText |
The text for the header label in the login window.
|
| LoginWindowLoginText |
The text for the login button in the login window.
|
| LoginWindowLogoutText |
The text for the logout button in the login window.
|
| LoginWindowProxyPwdLabelText |
The text for the proxy password label in the login window.
|
| LoginWindowProxyServerLabelText |
The text for the proxy server label in the login window.
|
| LoginWindowProxyServerTabText |
The text for the proxy tab in the login window.
|
| LoginWindowProxyUserNameLabelText |
The text for the proxy username label in the login window.
|
| LoginWindowPwdLabelText |
The text for the password label in the login window.
|
| LoginWindowRallyServerTabText |
The text for the rally server tab in the login window.
|
| LoginWindowServerLabelText |
The text for the server label in the login window.
|
| LoginWindowSsoInProgressText |
The text for the sso in progress label in the login window.
|
| LoginWindowTitle |
The text for the login window title.
|
| LoginWindowTrustAllCertificatesText |
The text for the trust all certificates label in the login window.
|
| LoginWindowUserNameLabelText |
The text for the user name label in the login window.
|
| SsoAuthenticationComplete |
Notifies that SSO authentication has completed.
|
Methods| Name | Description | |
|---|---|---|
  | AutoAuthenticate |
Auto authenticates the user if there are saved credentials.
|
| Configure |
Configures the authorization manger.
|
| DeleteCachedLoginDetailsFromDisk |
Deletes any cached login credentials from disk.
|
| 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.
|
| OpenSsoPageInternal |
Opens the window that displays the SSO URL to the user.
|
| PerformAuthenticationCheck |
Performs an authentication check against an identity provider (IDP Initiated).
|
| PerformLogoutFromRally |
Performs an logout from Rally.
|
| ReportSsoResults |
Reports the results of an SSO action.
|
| ShowUserLoginWindow |
Authenticates the user against Rally. This must be called from the UI thread.
|
| ShowUserLoginWindowInternal |
Opens the window that displays the SSO URL to the user.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also