Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

AuthenticateResult Class

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.dll
Assembly:
Microsoft.AspNetCore.Authentication.Abstractions.dll
Package:
Microsoft.AspNetCore.Authentication v1.0.0
Package:
Microsoft.AspNetCore.Authentication v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
AuthenticateResult.cs
Source:
AuthenticateResult.cs
Source:
AuthenticateResult.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the result of an Authenticate call

public ref class AuthenticateResult
public class AuthenticateResult
type AuthenticateResult = class
Public Class AuthenticateResult
Inheritance
AuthenticateResult
Derived

Constructors

Name Description
AuthenticateResult()

Creates a new AuthenticateResult instance.

Properties

Name Description
Failure

Holds failure information from the authentication.

Handled

Indicates that stage of authentication was directly handled by user intervention and no further processing should be attempted.

None

Indicates that there was no information returned for this authentication scheme.

Principal

Gets the claims-principal with authenticated user identities.

Properties

Additional state values for the authentication session.

Skipped

Indicates that this stage of authentication was skipped by user intervention.

Succeeded

If a ticket was produced, authenticate was successful.

Ticket

The authentication ticket.

Methods

Name Description
Clone()

Create a new deep copy of the result

Fail(Exception, AuthenticationProperties)

Indicates that there was a failure during authentication.

Fail(Exception)

Indicates that there was a failure during authentication.

Fail(String, AuthenticationProperties)

Indicates that there was a failure during authentication.

Fail(String)

Indicates that there was a failure during authentication.

Handle()
NoResult()

Indicates that there was no information returned for this authentication scheme.

Skip()
Success(AuthenticationTicket)

Indicates that authentication was successful.

Applies to


Feedback

Was this page helpful?