OAuthChallengeProperties Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.OAuth

Assembly:

Microsoft.AspNetCore.Authentication.OAuth.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

AuthenticationProperties for an OAuth challenge.

public ref class OAuthChallengeProperties : Microsoft::AspNetCore::Authentication::AuthenticationProperties

public class OAuthChallengeProperties : Microsoft.AspNetCore.Authentication.AuthenticationProperties

type OAuthChallengeProperties = class
    inherit AuthenticationProperties

Public Class OAuthChallengeProperties
Inherits AuthenticationProperties

Inheritance

Object

AuthenticationProperties

OAuthChallengeProperties

Derived

Microsoft.AspNetCore.Authentication.Google.GoogleChallengeProperties

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftChallengeProperties

Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectChallengeProperties

Constructors

OAuthChallengeProperties()	Initializes a new instance of OAuthChallengeProperties.
OAuthChallengeProperties(IDictionary<String,String>, IDictionary<String,Object>)	Initializes a new instance of OAuthChallengeProperties.
OAuthChallengeProperties(IDictionary<String,String>)	Initializes a new instance of OAuthChallengeProperties.

Fields

ScopeKey

The parameter key for the "scope" argument being used for a challenge request.

Properties

AllowRefresh	Gets or sets if refreshing the authentication session should be allowed. (Inherited from AuthenticationProperties)
ExpiresUtc	Gets or sets the time at which the authentication ticket expires. (Inherited from AuthenticationProperties)
IsPersistent	Gets or sets whether the authentication session is persisted across multiple requests. (Inherited from AuthenticationProperties)
IssuedUtc	Gets or sets the time at which the authentication ticket was issued. (Inherited from AuthenticationProperties)
Items	State values about the authentication session. (Inherited from AuthenticationProperties)
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. (Inherited from AuthenticationProperties)
RedirectUri	Gets or sets the full path or absolute URI to be used as an http redirect response value. (Inherited from AuthenticationProperties)
Scope	The "scope" parameter value being used for a challenge request.

Methods

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

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.