MicrosoftChallengeProperties Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.MicrosoftAccount

Assembly:

Microsoft.AspNetCore.Authentication.MicrosoftAccount.dll

Package:

Microsoft.AspNetCore.Authentication.MicrosoftAccount v8.0.0

Source:

MicrosoftChallengeProperties.cs

AuthenticationProperties for Microsoft OAuth challenge request. See https://learn.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow#request-an-authorization-code for reference.

public ref class MicrosoftChallengeProperties : Microsoft::AspNetCore::Authentication::OAuth::OAuthChallengeProperties

public class MicrosoftChallengeProperties : Microsoft.AspNetCore.Authentication.OAuth.OAuthChallengeProperties

type MicrosoftChallengeProperties = class
    inherit OAuthChallengeProperties

Public Class MicrosoftChallengeProperties
Inherits OAuthChallengeProperties

Inheritance

Object

AuthenticationProperties

OAuthChallengeProperties

MicrosoftChallengeProperties

Constructors

MicrosoftChallengeProperties()	Initializes a new instance for MicrosoftChallengeProperties.
MicrosoftChallengeProperties(IDictionary<String,String>)	Initializes a new instance for MicrosoftChallengeProperties.
MicrosoftChallengeProperties(IDictionary<String,String>, IDictionary<String,Object>)	Initializes a new instance for MicrosoftChallengeProperties.

Fields

DomainHintKey	The parameter key for the "domain_hint" argument being used for a challenge request.
LoginHintKey	The parameter key for the "login_hint" argument being used for a challenge request.
PromptKey	The parameter key for the "prompt" argument being used for a challenge request.
ResponseModeKey	Obsolete. The parameter key for the "response_mode" argument being used for a challenge request.

Properties

AllowRefresh	Gets or sets if refreshing the authentication session should be allowed. (Inherited from AuthenticationProperties)
DomainHint	Gets or sets the value for the "domain_hint" parameter value being used for a challenge request. If included, authentication will skip the email-based discovery process that user goes through on the sign-in page, leading to a slightly more streamlined user experience.
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)
LoginHint	Gets or sets the value for the "login_hint" parameter value being used for a challenge request. Can be used to pre-fill the username/email address field of the sign-in page for the user, if their username is known ahead of time.
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)
Prompt	Gets or sets the value for the "prompt" parameter value being used for a challenge request. Indicates the type of user interaction that is required. The only valid values at this time are login, none, and consent.
RedirectUri	Gets or sets the full path or absolute URI to be used as an http redirect response value. (Inherited from AuthenticationProperties)
ResponseMode	Obsolete. Gets or sets the value for the response_mode parameter used for a challenge request. The response mode specifies the method that should be used to send the resulting token back to the app. Can be one of the following: query, fragment, form_post.
Scope	The "scope" parameter value being used for a challenge request. (Inherited from OAuthChallengeProperties)

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. (Inherited from OAuthChallengeProperties)
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.