TwitterOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.Twitter

Assembly:

Microsoft.AspNetCore.Authentication.Twitter.dll

Package:

Microsoft.AspNetCore.Authentication.Twitter v8.0.0

Source:

TwitterOptions.cs

Options for the Twitter authentication handler.

public ref class TwitterOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class TwitterOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type TwitterOptions = class
    inherit RemoteAuthenticationOptions

Public Class TwitterOptions
Inherits RemoteAuthenticationOptions

Inheritance

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

TwitterOptions

Constructors

TwitterOptions()

Initializes a new instance of the TwitterOptions class.

Properties

AccessDeniedPath	Gets or sets the optional path the user agent is redirected to if the user doesn't approve the authorization demand requested by the remote server. This property is not set by default. In this case, an exception is thrown if an access_denied response is returned by the remote authorization server. (Inherited from RemoteAuthenticationOptions)
Backchannel	Used to communicate with the remote identity provider. (Inherited from RemoteAuthenticationOptions)
BackchannelHttpHandler	The HttpMessageHandler used to communicate with remote identity provider. This cannot be set at the same time as BackchannelCertificateValidator unless the value can be downcast to a WebRequestHandler. (Inherited from RemoteAuthenticationOptions)
BackchannelTimeout	Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider. (Inherited from RemoteAuthenticationOptions)
CallbackPath	The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives. (Inherited from RemoteAuthenticationOptions)
ClaimActions	A collection of claim actions used to select values from the json user data and create Claims.
ClaimsIssuer	Gets or sets the issuer that should be used for any claims that are created (Inherited from AuthenticationSchemeOptions)
ConsumerKey	Gets or sets the consumer key used to communicate with Twitter.
ConsumerSecret	Gets or sets the consumer secret used to sign requests to Twitter.
CorrelationCookie	Determines the settings used to create the correlation cookie before the cookie gets added to the response. (Inherited from RemoteAuthenticationOptions)
DataProtectionProvider	Gets or sets the type used to secure data. (Inherited from RemoteAuthenticationOptions)
Events	Gets or sets the TwitterEvents used to handle authentication events.
EventsType	If set, will be used as the service type to get the Events instance instead of the property. (Inherited from AuthenticationSchemeOptions)
ForwardAuthenticate	If set, this specifies the target scheme that this scheme should forward AuthenticateAsync calls to. For example Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardChallenge	If set, this specifies the target scheme that this scheme should forward ChallengeAsync calls to. For example Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardDefault	If set, this specifies a default scheme that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to. (Inherited from AuthenticationSchemeOptions)
ForwardDefaultSelector	Used to select a default scheme for the current request that authentication handlers should forward all authentication operations to by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result will be used as the target scheme to forward to. (Inherited from AuthenticationSchemeOptions)
ForwardForbid	If set, this specifies the target scheme that this scheme should forward ForbidAsync calls to. For example Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardSignIn	If set, this specifies the target scheme that this scheme should forward SignInAsync calls to. For example Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
ForwardSignOut	If set, this specifies the target scheme that this scheme should forward SignOutAsync calls to. For example Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Set the target to the current scheme to disable forwarding and allow normal processing. (Inherited from AuthenticationSchemeOptions)
RemoteAuthenticationTimeout	Gets or sets the time limit for completing the authentication flow (15 minutes by default). (Inherited from RemoteAuthenticationOptions)
RetrieveUserDetails	Enables the retrieval user details during the authentication process, including e-mail addresses. Retrieving e-mail addresses requires special permissions from Twitter Support on a per application basis. The default is false. See https://dev.twitter.com/rest/reference/get/account/verify_credentials.
ReturnUrlParameter	Gets or sets the name of the parameter used to convey the original location of the user before the remote challenge was triggered up to the access denied page. This property is only used when the AccessDeniedPath is explicitly specified. (Inherited from RemoteAuthenticationOptions)
SaveTokens	Defines whether access and refresh tokens should be stored in the AuthenticationProperties after a successful authorization. This property is set to false by default to reduce the size of the final authentication cookie. (Inherited from RemoteAuthenticationOptions)
SignInScheme	Gets or sets the authentication scheme corresponding to the middleware responsible of persisting user's identity after a successful authentication. This value typically corresponds to a cookie middleware registered in the Startup class. When omitted, DefaultSignInScheme is used as a fallback value. (Inherited from RemoteAuthenticationOptions)
StateCookie	Determines the settings used to create the state cookie before the cookie gets added to the response.
StateDataFormat	Gets or sets the type used to secure data handled by the handler.
TimeProvider	Used for testing. (Inherited from AuthenticationSchemeOptions)

Methods

Validate()	Added the validate method to ensure that the customer key and customer secret values are not not empty for the twitter authentication middleware
Validate(String)	Checks that the options are valid for a specific scheme (Inherited from RemoteAuthenticationOptions)