RallyRestApi.AuthenticateWithApiKey Method (String, Uri, WebProxy)

RallyRestApiAuthenticateWithApiKey Method (String, Uri, 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,
	Uri serverUrl,
	WebProxy proxy = null
)

Public Function AuthenticateWithApiKey ( 
	apiKey As String,
	serverUrl As Uri,
	Optional proxy As WebProxy = Nothing
) As RallyRestApiAuthenticationResult

public:
RallyRestApiAuthenticationResult AuthenticateWithApiKey(
	String^ apiKey, 
	Uri^ serverUrl, 
	WebProxy^ proxy = nullptr
)

member AuthenticateWithApiKey : 
        apiKey : string * 
        serverUrl : Uri * 
        ?proxy : WebProxy 
(* Defaults:
        let _proxy = defaultArg proxy null
*)
-> RallyRestApiAuthenticationResult

Parameters

apiKey: Type: SystemString
The API key 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

Return Value

Type: RallyRestApiAuthenticationResult
The current state of the authentication process. RallyRestApiAuthenticationResult

Exceptions

Exception	Condition
RallyUnavailableException	Rally returned an HTML page. This usually occurs when Rally is off-line. Please check the ErrorMessage property for more information.
RallyFailedToDeserializeJson	The JSON returned by Rally was not able to be deserialized. Please check the JsonData property for what was returned by Rally.

Examples

Copy

RallyRestApi restApi = new RallyRestApi();
WebProxy myProxy = new WebProxy();
restApi.AuthenticateWithApiKey("ApiKeyFromRally", new Uri("https://myserverurl"), proxy: myProxy);

Reference

RallyRestApi Class

AuthenticateWithApiKey Overload

Rally.RestApi Namespace