|
SecurityPrincipalGetFailureReasonPhrase Method
|
Gets the reason phrase to return for an unauthorized response.
Namespace: GSF.SecurityAssembly: GSF.Security (in GSF.Security.dll) Version: 2.4.248-beta
Syntaxpublic static string GetFailureReasonPhrase(
SecurityPrincipal securityPrincipal,
string authorizationScheme = "Basic",
bool useProviderReason = false
)
Public Shared Function GetFailureReasonPhrase (
securityPrincipal As SecurityPrincipal,
Optional authorizationScheme As String = "Basic",
Optional useProviderReason As Boolean = false
) As String
public:
static String^ GetFailureReasonPhrase(
SecurityPrincipal^ securityPrincipal,
String^ authorizationScheme = L"Basic",
bool useProviderReason = false
)
static member GetFailureReasonPhrase :
securityPrincipal : SecurityPrincipal *
?authorizationScheme : string *
?useProviderReason : bool
(* Defaults:
let _authorizationScheme = defaultArg authorizationScheme "Basic"
let _useProviderReason = defaultArg useProviderReason false
*)
-> string
GSF.Security.SecurityPrincipal.GetFailureReasonPhrase = function(securityPrincipal, authorizationScheme, useProviderReason);
View SourceParameters
- 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
StringReason 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