Microsoft.AspNetCore.Authentication.Abstractions

Contains the result of an Authenticate call

Creates a new instance.

If a ticket was produced, authenticate was successful.

The authentication ticket.

Gets the claims-principal with authenticated user identities.

Additional state values for the authentication session.

Holds failure information from the authentication.

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

Create a new deep copy of the result

A copy of the result

Indicates that authentication was successful.

The ticket representing the authentication result. The result.

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

The result.

Indicates that there was a failure during authentication.

The failure exception. The result.

Indicates that there was a failure during authentication.

The failure exception. Additional state values for the authentication session. The result.

Indicates that there was a failure during authentication.

The failure message. The result.

Indicates that there was a failure during authentication.

The failure message. Additional state values for the authentication session. The result.

A generic authentication failure.

Creates a new instance of with the specified exception .

The message that describes the error.

Creates a new instance of with the specified exception and a reference to the inner exception that is the cause of this exception.

The message that describes the error. The exception that is the cause of the current exception, or .

Extension methods to expose Authentication on HttpContext.

Authenticate the current request using the default authentication scheme. The default authentication scheme can be configured using .

The context. The .

Authenticate the current request using the specified scheme.

The context. The name of the authentication scheme. The .

Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.

The context. The name of the authentication scheme. The result.

Challenge the current request using the default challenge scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication. The default challenge scheme can be configured using .

The context. The task.

The context. The properties. The task.

Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.

The context. The name of the authentication scheme. The properties. The task.

Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.

The context. The name of the authentication scheme. The task.

Forbid the current request using the default forbid scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access. The default forbid scheme can be configured using .

The context. The task.

The context. The properties. The task.

Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.

The context. The name of the authentication scheme. The properties. The task.

The context. The name of the authentication scheme. The user. The task.

The context. The user. The task.

The context. The user. The properties. The task.

The context. The name of the authentication scheme. The user. The properties. The task.

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using .

The context. The task.

Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using .

The context. The properties. The task.

Sign out a principal for the specified scheme.

The context. The name of the authentication scheme. The task.

Sign out a principal for the specified scheme.

The context. The name of the authentication scheme. The properties. The task.

Authenticates the request using the specified scheme and returns the value for the token.

The context. The name of the authentication scheme. The name of the token. The value of the token if present.

Authenticates the request using the default authentication scheme and returns the value for the token. The default authentication scheme can be configured using .

The context. The name of the token. The value of the token if present.

Options to configure authentication.

Returns the schemes in the order they were added (important for request handling priority)

Maps schemes by name.

Adds an .

The name of the scheme being added. Configures the scheme.

Adds an .

The responsible for the scheme. The name of the scheme being added. The display name for the scheme.

Used as the fallback default scheme for all the other defaults.

Used as the default scheme by .

If true, SignIn should throw if attempted with a user is not authenticated. A user is considered authenticated if returns for the associated with the HTTP request.

If true, DefaultScheme will not automatically use a single registered scheme.

Dictionary used to store state values about the authentication session.

Initializes a new instance of the class.

State values dictionary to use.

Initializes a new instance of the class.

State values dictionary to use. Parameters dictionary to use.

Return a copy.

A copy.

State values about the authentication session.

Collection of parameters that are passed to the authentication handler. These are not intended for serialization or persistence, only for flowing data between call sites.

Gets or sets whether the authentication session is persisted across multiple requests.

Gets or sets the full path or absolute URI to be used as an http redirect response value.

Gets or sets the time at which the authentication ticket was issued.

Gets or sets the time at which the authentication ticket expires.

Gets or sets if refreshing the authentication session should be allowed.

Get a string value from the collection.

Property key. Retrieved value or null if the property is not set.

Set or remove a string value from the collection.

Property key. Value to set or to remove the property.

Get a parameter from the collection.

Parameter type. Parameter key. Retrieved value or the default value if the property is not set.

Set a parameter value in the collection.

Parameter type. Parameter key. Value to set.

Get a nullable from the collection.

Property key. Retrieved value or if the property is not set.

Set or remove a value in the collection.

Property key. Value to set or to remove the property.

Get a nullable value from the collection.

Property key. Retrieved value or if the property is not set.

Sets or removes a value in the collection.

Property key. Value to set or to remove the property.

AuthenticationSchemes assign a name to a specific handlerType.

Initializes a new instance of .

The name for the authentication scheme. The display name for the authentication scheme. The type that handles this scheme.

The name of the authentication scheme.

The display name for the scheme. Null is valid and used for non user facing schemes.

The type that handles this scheme.

Used to build s.

Constructor.

The name of the scheme being built.

Gets the name of the scheme being built.

Gets or sets the display name for the scheme being built.

Gets or sets the type responsible for this scheme.

Builds the instance.

The .

Contains user identity information as well as additional authentication state.

Initializes a new instance of the class

the that represents the authenticated user. additional properties that can be consumed by the user or runtime. the authentication scheme that was responsible for this ticket.

Initializes a new instance of the class

the that represents the authenticated user. the authentication scheme that was responsible for this ticket.

Gets the authentication scheme that was responsible for this ticket.

Gets the claims-principal with authenticated user identities.

Additional state values for the authentication session.

Returns a copy of the ticket.

The method clones the by calling on each of the . A copy of the ticket

Name/Value representing a token.

Name.

Value.

Used to capture the from the authorization middleware.

The from the authorization middleware. Set to null if the property is set after the authorization middleware.

Provides an interface for implmenting a construct that provides access to authentication-related configuration sections.

Gets the where authentication options are stored.

Used to capture path info so redirects can be computed properly within an app.Map().

The original path base.

The original path.

Created per request to handle authentication for a particular scheme.

Initialize the authentication handler. The handler should initialize anything it needs from the request and scheme as part of this method.

The scheme. The context.

Authenticate the current request.

The result.

Challenge the current request.

The that contains the extra meta-data arriving with the authentication.

Forbid the current request.

The that contains the extra meta-data arriving with the authentication.

Provides the appropriate IAuthenticationHandler instance for the authenticationScheme and request.

Returns the handler instance that will be used.

The . The name of the authentication scheme being handled. The handler instance.

Used to determine if a handler wants to participate in request processing.

Gets a value that determines if the request should stop being processed. This feature is supported by the Authentication middleware which does not invoke any subsequent or middleware configured in the request pipeline if the handler returns .

if request processing should stop.

Responsible for managing what authenticationSchemes are supported.

Returns all currently registered s.

All currently registered s.

Returns the matching the name, or null.

The name of the authenticationScheme. The scheme or null if not found.

Returns the scheme that will be used by default for . This is typically specified via . Otherwise, this will fallback to .