Click or drag to resize
RallyRestApiAuthenticate Method (String, String, Uri, WebProxy, Boolean)
Authenticates against Rally with the specified credentials

Namespace: Rally.RestApi
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)
Syntax
public RallyRestApiAuthenticationResult Authenticate(
	string username,
	string password,
	Uri serverUrl,
	WebProxy proxy = null,
	bool allowSSO = true
)

Parameters

username
Type: SystemString
The user name to be used for access
password
Type: SystemString
The password to be used for access
serverUrl
Type: SystemUri
The Rally server to use (defaults to DEFAULT_SERVER)
proxy (Optional)
Type: System.NetWebProxy
Optional proxy configuration
allowSSO (Optional)
Type: SystemBoolean
Is SSO authentication allowed for this call? It can be useful to disable this during startup processes.

Return Value

Type: RallyRestApiAuthenticationResult
The current state of the authentication process. RallyRestApiAuthenticationResult
Exceptions
ExceptionCondition
RallyUnavailableExceptionRally returned an HTML page. This usually occurs when Rally is off-line. Please check the ErrorMessage property for more information.
RallyFailedToDeserializeJsonThe JSON returned by Rally was not able to be deserialized. Please check the JsonData property for what was returned by Rally.
Examples
C#
RallyRestApi restApi = new RallyRestApi();
WebProxy myProxy = new WebProxy();
restApi.Authenticate("myuser@company.com", "password", new Uri("https://myserverurl"), proxy: myProxy);
See Also