CookieSigningInContext Class¶
Context object passed to the ICookieAuthenticationEvents method SigningIn.
- Namespace
Microsoft.AspNetCore.Authentication.Cookies
- Assemblies
- Microsoft.AspNetCore.Authentication.Cookies
Syntax¶
public class CookieSigningInContext : BaseCookieContext
-
class
Microsoft.AspNetCore.Authentication.Cookies.
CookieSigningInContext
Constructors¶
-
CookieSigningInContext
(Microsoft.AspNetCore.Http.HttpContext, Microsoft.AspNetCore.Builder.CookieAuthenticationOptions, System.String, System.Security.Claims.ClaimsPrincipal, Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties, Microsoft.AspNetCore.Http.CookieOptions)¶ Creates a new instance of the context object.
Arguments: - context (Microsoft.AspNetCore.Http.HttpContext) – The HTTP request context
- options (Microsoft.AspNetCore.Builder.CookieAuthenticationOptions) – The middleware options
- authenticationScheme (System.String) – Initializes AuthenticationScheme property
- principal (System.Security.Claims.ClaimsPrincipal) – Initializes Principal property
- properties (Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties) – Initializes Extra property
- cookieOptions (Microsoft.AspNetCore.Http.CookieOptions) – Initializes options for the authentication cookie.
public CookieSigningInContext(HttpContext context, CookieAuthenticationOptions options, string authenticationScheme, ClaimsPrincipal principal, AuthenticationProperties properties, CookieOptions cookieOptions)
-
Properties¶
-
Microsoft.AspNetCore.Authentication.Cookies.CookieSigningInContext.
AuthenticationScheme
¶ The name of the AuthenticationScheme creating a cookie
Return type: System.String public string AuthenticationScheme { get; }
-
Microsoft.AspNetCore.Authentication.Cookies.CookieSigningInContext.
CookieOptions
¶ The options for creating the outgoing cookie. May be replace or altered during the SigningIn call.
Return type: Microsoft.AspNetCore.Http.CookieOptions public CookieOptions CookieOptions { get; set; }
-
Microsoft.AspNetCore.Authentication.Cookies.CookieSigningInContext.
Principal
¶ Contains the claims about to be converted into the outgoing cookie. May be replaced or altered during the SigningIn call.
Return type: System.Security.Claims.ClaimsPrincipal public ClaimsPrincipal Principal { get; set; }
-
Microsoft.AspNetCore.Authentication.Cookies.CookieSigningInContext.
Properties
¶ Contains the extra data about to be contained in the outgoing cookie. May be replaced or altered during the SigningIn call.
Return type: Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties public AuthenticationProperties Properties { get; set; }
-