Rally.RestApi.Auth.ApiAuthManager.PerformAuthenticationCheck C# (CSharp) Method

PerformAuthenticationCheck() protected method

Performs an authentication check against an identity provider (IDP Initiated).
protected PerformAuthenticationCheck ( string &errorMessage, bool allowSso = true ) : RallyRestApi.AuthenticationResult
errorMessage string The error message or any that was generated by the authentication check.
allowSso bool Is SSO allowed for this authentication check?
return RallyRestApi.AuthenticationResult
		protected RallyRestApi.AuthenticationResult PerformAuthenticationCheck(
			out string errorMessage, bool allowSso = true)
		{
			if (!IsUiSupported)
				throw new InvalidProgramException("This method is only supported by UI enabled Authentication Managers.");

			switch (LoginDetails.ConnectionType)
			{
				case ConnectionType.BasicAuth:
				case ConnectionType.SpBasedSso:
					return PerformAuthenticationCheckAgainstRally(out errorMessage, allowSso);
				case ConnectionType.IdpBasedSso:
					if (!allowSso)
					{
						errorMessage = "IDP based authorization disabled by calling sequence.";
						return RallyRestApi.AuthenticationResult.NotAuthorized;
					}

					return PerformAuthenticationCheckAgainstIdp(out errorMessage);
				default:
					throw new NotImplementedException();
			}
		}
		#endregion