Click or drag to resize
RallyRestApiAuthenticateWithApiKey Method (String, String, WebProxy)
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 AuthenticateWithApiKey(
	string apiKey,
	string rallyServer = "https://rally1.rallydev.com",
	WebProxy proxy = null
)

Parameters

apiKey
Type: SystemString
The API key to be used for access
rallyServer (Optional)
Type: SystemString
The Rally server to use (defaults to DEFAULT_SERVER)
proxy (Optional)
Type: System.NetWebProxy
Optional proxy configuration

Return Value

Type: RallyRestApiAuthenticationResult
An RallyRestApiAuthenticationResult that indicates the current state of the authentication process.
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.AuthenticateWithApiKey("ApiKeyFromRally", proxy: myProxy);
See Also