Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.AspNetCore.Authentication.AuthenticateResult
Assembly: Microsoft.AspNetCore.Authentication.Abstractions
Inheritance: object → AuthenticateResult
Contains the result of an Authenticate call
Properties
public
bool
Succeeded
If a ticket was produced, authenticate was successful.
public
AuthenticationTicket
Ticket
The authentication ticket.
Principal
Gets the claims-principal with authenticated user identities.
public
AuthenticationProperties
Properties
Additional state values for the authentication session.
public
System.Exception
Failure
Holds failure information from the authentication.
public
bool
None
Indicates that there was no information returned for this authentication scheme.
Methods
Returns A copy of the result
public static
AuthenticateResult
Success(AuthenticationTicket ticket)
Indicates that authentication was successful.
Returns The result.
ticket
The ticket representing the authentication result.
public static
AuthenticateResult
NoResult()
Indicates that there was no information returned for this authentication scheme.
Returns The result.
public static
AuthenticateResult
Fail(System.Exception failure)
Indicates that there was a failure during authentication.
Returns The result.
failure
The failure exception.
public static
AuthenticateResult
Fail(System.Exception failure,
AuthenticationProperties? properties)
Indicates that there was a failure during authentication.
Returns The result.
failure
The failure exception.
properties
Additional state values for the authentication session.
public static
AuthenticateResult
Fail(string failureMessage)
Indicates that there was a failure during authentication.
Returns The result.
failureMessage
The failure message.
public static
AuthenticateResult
Fail(string failureMessage,
AuthenticationProperties? properties)
Indicates that there was a failure during authentication.
Returns The result.
failureMessage
The failure message.
properties
Additional state values for the authentication session.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object