ApiAuthManager.PerformAuthenticationCheck Method

ApiAuthManagerPerformAuthenticationCheck Method

Performs an authentication check against an identity provider (IDP Initiated).

Namespace: Rally.RestApi.Auth
Assembly: Rally.RestApi (in Rally.RestApi.dll) Version: 3.1.1.0 (3.1.1.0)

Syntax

protected RallyRestApiAuthenticationResult PerformAuthenticationCheck(
	out string errorMessage,
	bool allowSso = true
)

Protected Function PerformAuthenticationCheck ( 
	<OutAttribute> ByRef errorMessage As String,
	Optional allowSso As Boolean = true
) As RallyRestApiAuthenticationResult

protected:
RallyRestApiAuthenticationResult PerformAuthenticationCheck(
	[OutAttribute] String^% errorMessage, 
	bool allowSso = true
)

member PerformAuthenticationCheck : 
        errorMessage : string byref * 
        ?allowSso : bool 
(* Defaults:
        let _allowSso = defaultArg allowSso true
*)
-> RallyRestApiAuthenticationResult

Parameters

errorMessage: Type: SystemString
The error message or any that was generated by the authentication check.
allowSso (Optional): Type: SystemBoolean
Is SSO allowed for this authentication check?

Return Value

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

Examples

Copy

RallyRestApi.AuthenticationResult result = PerformAuthenticationCheck(out errorMessage);

Reference

ApiAuthManager Class

Rally.RestApi.Auth Namespace