Click or drag to resize
ApiConsoleAuthManager Class
A authentication manager for a manually implemented authentication.
Inheritance Hierarchy
SystemObject
  Rally.RestApi.AuthApiAuthManager
    Rally.RestApi.AuthApiConsoleAuthManager

Namespace: Rally.RestApi.Auth
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public class ApiConsoleAuthManager : ApiAuthManager

The ApiConsoleAuthManager type exposes the following members.

Constructors
  NameDescription
Public methodApiConsoleAuthManager
Constructor
Top
Properties
  NameDescription
Public propertyApi
The API that is linked to this authorization manager.
(Inherited from ApiAuthManager.)
Protected propertyAuthenticationStateChange
Notifies that SSO authentication has completed.
(Inherited from ApiAuthManager.)
Public propertyIsUiSupported
Is the UI supported?
(Inherited from ApiAuthManager.)
Public propertyLoginDetails
The details for the user who is logging in using this auth manager.
(Inherited from ApiAuthManager.)
Protected propertySsoAuthenticationComplete
Notifies that SSO authentication has completed.
(Inherited from ApiAuthManager.)
Top
Methods
  NameDescription
Public methodCode exampleAutoAuthenticate
Auto authenticates the user if there are saved credentials.
(Inherited from ApiAuthManager.)
Public methodCode exampleDeleteCachedLoginDetailsFromDisk
Deletes any cached login credentials from disk.
(Inherited from ApiAuthManager.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNotifyLoginWindowSsoComplete
Notifies the login window that SSO has been completed.
(Overrides ApiAuthManagerNotifyLoginWindowSsoComplete(RallyRestApiAuthenticationResult, RallyRestApi).)
Protected methodOpenSsoPageInternal
Opens the window that displays the SSO URL to the user.
(Overrides ApiAuthManagerOpenSsoPageInternal(Uri).)
Protected methodCode examplePerformAuthenticationCheck
Performs an authentication check against an identity provider (IDP Initiated).
(Inherited from ApiAuthManager.)
Protected methodCode examplePerformLogoutFromRally
Performs an logout from Rally.
(Inherited from ApiAuthManager.)
Protected methodReportSsoResults
Reports the results of an SSO action.
(Inherited from ApiAuthManager.)
Public methodCode exampleShowUserLoginWindow
Authenticates the user against Rally. This must be called from the UI thread.
(Inherited from ApiAuthManager.)
Protected methodShowUserLoginWindowInternal
Opens the window that displays the SSO URL to the user.
(Overrides ApiAuthManagerShowUserLoginWindowInternal.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also