ApiAuthManagerConfigure Method |
Configures the authorization manger.
Namespace: Rally.RestApi.AuthAssembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntaxpublic 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
)
Public Shared Sub Configure (
Optional loginWindowTitle As String = Nothing,
Optional loginWindowHeaderLabelText As String = Nothing,
Optional loginWindowCredentialsTabText As String = Nothing,
Optional loginWindowUserNameLabelText As String = Nothing,
Optional loginWindowPwdLabelText As String = Nothing,
Optional loginWindowServerTabText As String = Nothing,
Optional loginWindowConnectionTypeText As String = Nothing,
Optional loginWindowServerLabelText As String = Nothing,
Optional loginWindowTrustAllCertificatesText As String = Nothing,
Optional loginWindowDefaultServer As Uri = Nothing,
Optional loginWindowProxyServerTabText As String = Nothing,
Optional loginWindowProxyServerLabelText As String = Nothing,
Optional loginWindowProxyUserNameLabelText As String = Nothing,
Optional loginWindowProxyPwdLabelText As String = Nothing,
Optional loginWindowDefaultProxyServer As Uri = Nothing,
Optional loginWindowSsoInProgressText As String = Nothing,
Optional loginWindowLoginButtonText As String = Nothing,
Optional loginWindowLogoutButtonText As String = Nothing,
Optional loginWindowCancelButtonText As String = Nothing,
Optional loginFailureBadServer As String = Nothing,
Optional loginFailureCredentials As String = Nothing,
Optional loginFailureLoginEmpty As String = Nothing,
Optional loginFailureServerEmpty As String = Nothing,
Optional loginFailureProxyCredentials As String = Nothing,
Optional loginFailureBadConnection As String = Nothing,
Optional loginFailureUnknown As String = Nothing
)
public:
static void Configure(
String^ loginWindowTitle = nullptr,
String^ loginWindowHeaderLabelText = nullptr,
String^ loginWindowCredentialsTabText = nullptr,
String^ loginWindowUserNameLabelText = nullptr,
String^ loginWindowPwdLabelText = nullptr,
String^ loginWindowServerTabText = nullptr,
String^ loginWindowConnectionTypeText = nullptr,
String^ loginWindowServerLabelText = nullptr,
String^ loginWindowTrustAllCertificatesText = nullptr,
Uri^ loginWindowDefaultServer = nullptr,
String^ loginWindowProxyServerTabText = nullptr,
String^ loginWindowProxyServerLabelText = nullptr,
String^ loginWindowProxyUserNameLabelText = nullptr,
String^ loginWindowProxyPwdLabelText = nullptr,
Uri^ loginWindowDefaultProxyServer = nullptr,
String^ loginWindowSsoInProgressText = nullptr,
String^ loginWindowLoginButtonText = nullptr,
String^ loginWindowLogoutButtonText = nullptr,
String^ loginWindowCancelButtonText = nullptr,
String^ loginFailureBadServer = nullptr,
String^ loginFailureCredentials = nullptr,
String^ loginFailureLoginEmpty = nullptr,
String^ loginFailureServerEmpty = nullptr,
String^ loginFailureProxyCredentials = nullptr,
String^ loginFailureBadConnection = nullptr,
String^ loginFailureUnknown = nullptr
)
static member Configure :
?loginWindowTitle : string *
?loginWindowHeaderLabelText : string *
?loginWindowCredentialsTabText : string *
?loginWindowUserNameLabelText : string *
?loginWindowPwdLabelText : string *
?loginWindowServerTabText : string *
?loginWindowConnectionTypeText : string *
?loginWindowServerLabelText : string *
?loginWindowTrustAllCertificatesText : string *
?loginWindowDefaultServer : Uri *
?loginWindowProxyServerTabText : string *
?loginWindowProxyServerLabelText : string *
?loginWindowProxyUserNameLabelText : string *
?loginWindowProxyPwdLabelText : string *
?loginWindowDefaultProxyServer : Uri *
?loginWindowSsoInProgressText : string *
?loginWindowLoginButtonText : string *
?loginWindowLogoutButtonText : string *
?loginWindowCancelButtonText : string *
?loginFailureBadServer : string *
?loginFailureCredentials : string *
?loginFailureLoginEmpty : string *
?loginFailureServerEmpty : string *
?loginFailureProxyCredentials : string *
?loginFailureBadConnection : string *
?loginFailureUnknown : string
(* Defaults:
let _loginWindowTitle = defaultArg loginWindowTitle null
let _loginWindowHeaderLabelText = defaultArg loginWindowHeaderLabelText null
let _loginWindowCredentialsTabText = defaultArg loginWindowCredentialsTabText null
let _loginWindowUserNameLabelText = defaultArg loginWindowUserNameLabelText null
let _loginWindowPwdLabelText = defaultArg loginWindowPwdLabelText null
let _loginWindowServerTabText = defaultArg loginWindowServerTabText null
let _loginWindowConnectionTypeText = defaultArg loginWindowConnectionTypeText null
let _loginWindowServerLabelText = defaultArg loginWindowServerLabelText null
let _loginWindowTrustAllCertificatesText = defaultArg loginWindowTrustAllCertificatesText null
let _loginWindowDefaultServer = defaultArg loginWindowDefaultServer null
let _loginWindowProxyServerTabText = defaultArg loginWindowProxyServerTabText null
let _loginWindowProxyServerLabelText = defaultArg loginWindowProxyServerLabelText null
let _loginWindowProxyUserNameLabelText = defaultArg loginWindowProxyUserNameLabelText null
let _loginWindowProxyPwdLabelText = defaultArg loginWindowProxyPwdLabelText null
let _loginWindowDefaultProxyServer = defaultArg loginWindowDefaultProxyServer null
let _loginWindowSsoInProgressText = defaultArg loginWindowSsoInProgressText null
let _loginWindowLoginButtonText = defaultArg loginWindowLoginButtonText null
let _loginWindowLogoutButtonText = defaultArg loginWindowLogoutButtonText null
let _loginWindowCancelButtonText = defaultArg loginWindowCancelButtonText null
let _loginFailureBadServer = defaultArg loginFailureBadServer null
let _loginFailureCredentials = defaultArg loginFailureCredentials null
let _loginFailureLoginEmpty = defaultArg loginFailureLoginEmpty null
let _loginFailureServerEmpty = defaultArg loginFailureServerEmpty null
let _loginFailureProxyCredentials = defaultArg loginFailureProxyCredentials null
let _loginFailureBadConnection = defaultArg loginFailureBadConnection null
let _loginFailureUnknown = defaultArg loginFailureUnknown null
*)
-> unit
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.
ExamplesConfigures 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.
ApiAuthManager.Configure(loginWindowServerLabelText: "My Updated Server Label", loginWindowDefaultServer: new Uri("http://onprem-url"));
See Also