RallyRestApiAuthenticate Method (String, String, Uri, WebProxy, Boolean) |
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 Authenticate(
string username,
string password,
Uri serverUrl,
WebProxy proxy = null,
bool allowSSO = true
)
Public Function Authenticate (
username As String,
password As String,
serverUrl As Uri,
Optional proxy As WebProxy = Nothing,
Optional allowSSO As Boolean = true
) As RallyRestApiAuthenticationResult
public:
RallyRestApiAuthenticationResult Authenticate(
String^ username,
String^ password,
Uri^ serverUrl,
WebProxy^ proxy = nullptr,
bool allowSSO = true
)
member Authenticate :
username : string *
password : string *
serverUrl : Uri *
?proxy : WebProxy *
?allowSSO : bool
(* Defaults:
let _proxy = defaultArg proxy null
let _allowSSO = defaultArg allowSSO true
*)
-> RallyRestApiAuthenticationResult
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:
RallyRestApiAuthenticationResultThe current state of the authentication process.
RallyRestApiAuthenticationResultExceptions 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.Authenticate("myuser@company.com", "password", new Uri("https://myserverurl"), proxy: myProxy);
See Also