AuthenticationProperties Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication

Assembly:

Microsoft.AspNetCore.Authentication.Abstractions.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Dictionary used to store state values about the authentication session.

public ref class AuthenticationProperties

public class AuthenticationProperties

type AuthenticationProperties = class

Public Class AuthenticationProperties

Inheritance

Object

AuthenticationProperties

Derived

Microsoft.AspNetCore.Authentication.OAuth.OAuthChallengeProperties

Constructors

AuthenticationProperties()	Initializes a new instance of the AuthenticationProperties class.
AuthenticationProperties(IDictionary<String,String>, IDictionary<String,Object>)	Initializes a new instance of the AuthenticationProperties class.
AuthenticationProperties(IDictionary<String,String>)	Initializes a new instance of the AuthenticationProperties class.

Properties

AllowRefresh	Gets or sets if refreshing the authentication session should be allowed.
ExpiresUtc	Gets or sets the time at which the authentication ticket expires.
IsPersistent	Gets or sets whether the authentication session is persisted across multiple requests.
IssuedUtc	Gets or sets the time at which the authentication ticket was issued.
Items	State values about the authentication session.
Parameters	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.
RedirectUri	Gets or sets the full path or absolute URI to be used as an http redirect response value.

Methods

Clone()	Return a copy.
GetBool(String)	Get a nullable Boolean from the Items collection.
GetDateTimeOffset(String)	Get a nullable DateTimeOffset value from the Items collection.
GetParameter<T>(String)	Get a parameter from the Parameters collection.
GetString(String)	Get a string value from the Items collection.
SetBool(String, Nullable<Boolean>)	Set or remove a Boolean value in the Items collection.
SetDateTimeOffset(String, Nullable<DateTimeOffset>)	Sets or removes a DateTimeOffset value in the Items collection.
SetParameter<T>(String, T)	Set a parameter value in the Parameters collection.
SetString(String, String)	Set or remove a string value from the Items collection.

Extension Methods

GetTokens(AuthenticationProperties)	Returns all of the AuthenticationToken instances contained in the properties.
GetTokenValue(AuthenticationProperties, String)	Returns the value of a token.
StoreTokens(AuthenticationProperties, IEnumerable<AuthenticationToken>)	Stores a set of authentication tokens, after removing any old tokens.
UpdateTokenValue(AuthenticationProperties, String, String)	Updates the value of a token if already present.