Click or drag to resize
ApiAuthManagerConfigure Method
Configures the authorization manger.

Namespace: Rally.RestApi.Auth
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public static void Configure(
	string loginWindowTitle = null,
	string loginWindowHeaderLabelText = null,
	string loginWindowCredentialsTabText = null,
	string loginWindowUserNameLabelText = null,
	string loginWindowPwdLabelText = null,
	string loginWindowServerTabText = null,
	string loginWindowConnectionTypeText = null,
	string loginWindowServerLabelText = null,
	string loginWindowTrustAllCertificatesText = null,
	Uri loginWindowDefaultServer = null,
	string loginWindowProxyServerTabText = null,
	string loginWindowProxyServerLabelText = null,
	string loginWindowProxyUserNameLabelText = null,
	string loginWindowProxyPwdLabelText = null,
	Uri loginWindowDefaultProxyServer = null,
	string loginWindowSsoInProgressText = null,
	string loginWindowLoginButtonText = null,
	string loginWindowLogoutButtonText = null,
	string loginWindowCancelButtonText = null,
	string loginFailureBadServer = null,
	string loginFailureCredentials = null,
	string loginFailureLoginEmpty = null,
	string loginFailureServerEmpty = null,
	string loginFailureProxyCredentials = null,
	string loginFailureBadConnection = null,
	string loginFailureUnknown = null
)

Parameters

loginWindowTitle (Optional)
Type: SystemString
The title to be used for the login window.
loginWindowHeaderLabelText (Optional)
Type: SystemString
The header title to be used for the login window.
loginWindowCredentialsTabText (Optional)
Type: SystemString
The credentials tab text to be used for the login window.
loginWindowUserNameLabelText (Optional)
Type: SystemString
The user name label to be used for the login window.
loginWindowPwdLabelText (Optional)
Type: SystemString
The password label to be used for the login window.
loginWindowServerTabText (Optional)
Type: SystemString
The server tab label to be used for the login window.
loginWindowConnectionTypeText (Optional)
Type: SystemString
The connection type label to be used for the login window.
loginWindowServerLabelText (Optional)
Type: SystemString
The server label to be used for the login window.
loginWindowTrustAllCertificatesText (Optional)
Type: SystemString
The trust all certificates label to be used for the login window.
loginWindowDefaultServer (Optional)
Type: SystemUri
The default server to be used for the login window.
loginWindowProxyServerTabText (Optional)
Type: SystemString
The proxy tab label to be used for the login window.
loginWindowProxyServerLabelText (Optional)
Type: SystemString
The proxy server label to be used for the login window.
loginWindowProxyUserNameLabelText (Optional)
Type: SystemString
The proxy user name label to be used for the login window.
loginWindowProxyPwdLabelText (Optional)
Type: SystemString
The proxy password label to be used for the login window.
loginWindowDefaultProxyServer (Optional)
Type: SystemUri
The default proxy server to be used for the login window.
loginWindowSsoInProgressText (Optional)
Type: SystemString
The SSO in progress label to be used for the login window.
loginWindowLoginButtonText (Optional)
Type: SystemString
The login button text to be used for the login window.
loginWindowLogoutButtonText (Optional)
Type: SystemString
The logout button text to be used for the login window.
loginWindowCancelButtonText (Optional)
Type: SystemString
The cancel button text to be used for the login window.
loginFailureBadServer (Optional)
Type: SystemString
The error message to be used for when the server is bad (can't connect).
loginFailureCredentials (Optional)
Type: SystemString
The error message to be used for when the credentials to Rally are bad.
loginFailureLoginEmpty (Optional)
Type: SystemString
The error message to be used for when the login input field is left empty.
loginFailureServerEmpty (Optional)
Type: SystemString
The error message to be used for when the server input field is left empty.
loginFailureProxyCredentials (Optional)
Type: SystemString
The error message to be used for bad proxy credentials.
loginFailureBadConnection (Optional)
Type: SystemString
The error message to be used for bad connection login failures.
loginFailureUnknown (Optional)
Type: SystemString
The error message to be used for unknown login failures.
Examples

Configures labels for UI. These are global and used by the authentication manager to build their UI.

If this is not called, the default labels will be used. In this sample we are changing a label and the default server URL.

C#
ApiAuthManager.Configure(loginWindowServerLabelText: "My Updated Server Label", loginWindowDefaultServer: new Uri("http://onprem-url"));
See Also