Click or drag to resize

SecurityPrincipalGetFailureReasonPhrase Method

Gets the reason phrase to return for an unauthorized response.

Namespace: GSF.Security
Assembly: GSF.Security (in GSF.Security.dll) Version: 2.4.181-beta
Syntax
public static string GetFailureReasonPhrase(
	SecurityPrincipal securityPrincipal,
	string authorizationScheme = "Basic",
	bool useProviderReason = false
)
View Source

Parameters

securityPrincipal  SecurityPrincipal
Security principal being authenticated, can be null.
authorizationScheme  String  (Optional)
Authentication scheme in use.
useProviderReason  Boolean  (Optional)
true to use detailed response from security provider.

Return Value

String
Reason phrase to return for an unauthorized response.
Remarks
Detailed provider response should normally only be used for diagnostics, a more obscure reason is considered more secure since it limits knowledge about the successful elements of an authentication attempt.
See Also