AuthSchemeValidationResult

Namespace: ASPSecurityKit.AuthProviders
Assembly: ASPSecurityKit.dll

Summary

Represents the result of a IAuthenticationSchemeHandler operation.

Members

NotEvaluated

Summary

Shortcut property to create Evaluated as false.

Value

A new instance with Evaluated initialized as false.

Constructors

#ctor(error)

Summary

Initializes a new instance of the AuthSchemeValidationResult class representing a failed authentication.

Parameters
Name Type Description
error System.String The error details.
Exceptions
Type Description
System.ArgumentNullException When error is null or whitespace.

#ctor(auth)

Summary

Initializes a new instance of the AuthSchemeValidationResult class representing a successful authentication.

Parameters
Name Type Description
auth ASPSecurityKit.IAuthDetails The authenticated identity details.
Exceptions
Type Description
System.ArgumentNullException When auth is null.

Properties

Evaluated

Summary

Gets a value indicating whether the associated auth scheme handler evaluated the request for authentication. If there’s no matching scheme token in the request, no evaluation can be performed.

Value

true if request was evaluated; otherwise, false.

Error

Summary

Gets the error details.

Value

The error details.

Auth

Summary

Gets the identity details object after successful authentication by the associated auth scheme handler.

Value

The identity details object after successful authentication by the associated auth scheme handler.