CookieAuthenticationOptions CookieAuthenticationOptions CookieAuthenticationOptions CookieAuthenticationOptions Class

Definition

Configuration options for CookieAuthenticationMiddleware.

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>
type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>
Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)
Inheritance
CookieAuthenticationOptionsCookieAuthenticationOptionsCookieAuthenticationOptionsCookieAuthenticationOptions
Implements
Microsoft.Extensions.Options.IOptions<CookieAuthenticationOptions>

Constructors

CookieAuthenticationOptions() CookieAuthenticationOptions() CookieAuthenticationOptions() CookieAuthenticationOptions()

Create an instance of the options initialized with the default values

Properties

AccessDeniedPath AccessDeniedPath AccessDeniedPath AccessDeniedPath

The AccessDeniedPath property informs the middleware that it should change an outgoing 403 Forbidden status code into a 302 redirection onto the given path.

AuthenticationScheme AuthenticationScheme AuthenticationScheme AuthenticationScheme

The AuthenticationScheme in the options corresponds to the logical name for a particular authentication scheme. A different value may be assigned in order to use the same authentication middleware type more than once in a pipeline.

(Inherited from AuthenticationOptions)
AutomaticAuthenticate AutomaticAuthenticate AutomaticAuthenticate AutomaticAuthenticate

If true the authentication middleware alter the request user coming in. If false the authentication middleware will only provide identity when explicitly indicated by the AuthenticationScheme.

(Inherited from AuthenticationOptions)
AutomaticChallenge AutomaticChallenge AutomaticChallenge AutomaticChallenge

If true the authentication middleware should handle automatic challenge. If false the authentication middleware will only alter responses when explicitly indicated by the AuthenticationScheme.

(Inherited from AuthenticationOptions)
ClaimsIssuer ClaimsIssuer ClaimsIssuer ClaimsIssuer

Gets or sets the issuer that should be used for any claims that are created

(Inherited from AuthenticationOptions)
CookieDomain CookieDomain CookieDomain CookieDomain

Determines the domain used to create the cookie. Is not provided by default.

CookieHttpOnly CookieHttpOnly CookieHttpOnly CookieHttpOnly

Determines if the browser should allow the cookie to be accessed by client-side javascript. The default is true, which means the cookie will only be passed to http requests and is not made available to script on the page.

CookieManager CookieManager CookieManager CookieManager

The component used to get cookies from the request or set them on the response.

ChunkingCookieManager will be used by default.

CookieName CookieName CookieName CookieName

Determines the cookie name used to persist the identity. The default value is ".AspNetCore.Cookies". This value should be changed if you change the name of the AuthenticationScheme, especially if your system uses the cookie authentication middleware multiple times.

CookiePath CookiePath CookiePath CookiePath

Determines the path used to create the cookie. The default value is "/" for highest browser compatibility.

CookieSecure CookieSecure CookieSecure CookieSecure

Determines if the cookie should only be transmitted on HTTPS request. The default is to limit the cookie to HTTPS requests if the page which is doing the SignIn is also HTTPS. If you have an HTTPS sign in page and portions of your site are HTTP you may need to change this value.

DataProtectionProvider DataProtectionProvider DataProtectionProvider DataProtectionProvider

If set this will be used by the CookieAuthenticationMiddleware for data protection.

Description Description Description Description

Additional information about the authentication type which is made available to the application.

(Inherited from AuthenticationOptions)
Events Events Events Events

The Provider may be assigned to an instance of an object created by the application at startup time. The middleware calls methods on the provider which give the application control at certain points where processing is occurring. If it is not provided a default instance is supplied which does nothing when the methods are called.

ExpireTimeSpan ExpireTimeSpan ExpireTimeSpan ExpireTimeSpan

Controls how much time the cookie will remain valid from the point it is created. The expiration information is in the protected cookie ticket. Because of that an expired cookie will be ignored even if it is passed to the server after the browser should have purged it

LoginPath LoginPath LoginPath LoginPath

The LoginPath property informs the middleware that it should change an outgoing 401 Unauthorized status code into a 302 redirection onto the given login path. The current url which generated the 401 is added to the LoginPath as a query string parameter named by the ReturnUrlParameter. Once a request to the LoginPath grants a new SignIn identity, the ReturnUrlParameter value is used to redirect the browser back
to the url which caused the original unauthorized status code.

LogoutPath LogoutPath LogoutPath LogoutPath

If the LogoutPath is provided the middleware then a request to that path will redirect based on the ReturnUrlParameter.

ReturnUrlParameter ReturnUrlParameter ReturnUrlParameter ReturnUrlParameter

The ReturnUrlParameter determines the name of the query string parameter which is appended by the middleware when a 401 Unauthorized status code is changed to a 302 redirect onto the login path. This is also the query string parameter looked for when a request arrives on the login path or logout path, in order to return to the original url after the action is performed.

SessionStore SessionStore SessionStore SessionStore

An optional container in which to store the identity across requests. When used, only a session identifier is sent to the client. This can be used to mitigate potential problems with very large identities.

SlidingExpiration SlidingExpiration SlidingExpiration SlidingExpiration

The SlidingExpiration is set to true to instruct the middleware to re-issue a new cookie with a new expiration time any time it processes a request which is more than halfway through the expiration window.

SystemClock SystemClock SystemClock SystemClock

For testing purposes only.

TicketDataFormat TicketDataFormat TicketDataFormat TicketDataFormat

The TicketDataFormat is used to protect and unprotect the identity and other properties which are stored in the cookie value. If it is not provided a default data handler is created using the data protection service contained in the IApplicationBuilder.Properties. The default data protection service is based on machine key when running on ASP.NET, and on DPAPI when running in a different process.

Explicit Interface Implementations

IOptions<CookieAuthenticationOptions>.Value IOptions<CookieAuthenticationOptions>.Value IOptions<CookieAuthenticationOptions>.Value IOptions<CookieAuthenticationOptions>.Value

Applies to