RallyRestApiAuthenticateWithApiKey Method (String, String, WebProxy) |
Authenticates against Rally with the specified credentials
Namespace: Rally.RestApiAssembly: 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
)
Public Function AuthenticateWithApiKey (
apiKey As String,
Optional rallyServer As String = "https://rally1.rallydev.com",
Optional proxy As WebProxy = Nothing
) As RallyRestApiAuthenticationResult
public:
RallyRestApiAuthenticationResult AuthenticateWithApiKey(
String^ apiKey,
String^ rallyServer = L"https://rally1.rallydev.com",
WebProxy^ proxy = nullptr
)
member AuthenticateWithApiKey :
apiKey : string *
?rallyServer : string *
?proxy : WebProxy
(* Defaults:
let _rallyServer = defaultArg rallyServer "https://rally1.rallydev.com"
let _proxy = defaultArg proxy null
*)
-> RallyRestApiAuthenticationResult
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:
RallyRestApiAuthenticationResultAn
RallyRestApiAuthenticationResult that indicates the current state of the authentication process.
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 RallyRestApi restApi = new RallyRestApi();
WebProxy myProxy = new WebProxy();
restApi.AuthenticateWithApiKey("ApiKeyFromRally", proxy: myProxy);
See Also