RallyRestApiAuthenticateWithZSessionID Method |
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 AuthenticateWithZSessionID(
string userName,
string zSessionID,
string rallyServer = "https://rally1.rallydev.com",
WebProxy proxy = null,
bool allowSSO = true
)
Public Function AuthenticateWithZSessionID (
userName As String,
zSessionID As String,
Optional rallyServer As String = "https://rally1.rallydev.com",
Optional proxy As WebProxy = Nothing,
Optional allowSSO As Boolean = true
) As RallyRestApiAuthenticationResult
public:
RallyRestApiAuthenticationResult AuthenticateWithZSessionID(
String^ userName,
String^ zSessionID,
String^ rallyServer = L"https://rally1.rallydev.com",
WebProxy^ proxy = nullptr,
bool allowSSO = true
)
member AuthenticateWithZSessionID :
userName : string *
zSessionID : string *
?rallyServer : string *
?proxy : WebProxy *
?allowSSO : bool
(* Defaults:
let _rallyServer = defaultArg rallyServer "https://rally1.rallydev.com"
let _proxy = defaultArg proxy null
let _allowSSO = defaultArg allowSSO true
*)
-> RallyRestApiAuthenticationResult
Parameters
- userName
- Type: SystemString
The user name to be used for access - zSessionID
- Type: SystemString
The ZSessionID to be used for access. This would have been provided by Rally on a previous call. - rallyServer (Optional)
- Type: SystemString
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:
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.AuthenticateWithZSessionID("myuser@company.com", "zSessionID", proxy: myProxy);
See Also