FacebookOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Authentication.Facebook

Assembly:

Microsoft.AspNetCore.Authentication.Facebook.dll

Package:

Microsoft.AspNetCore.Authentication.Facebook v9.0.0

Source:

FacebookOptions.cs

Configuration options for FacebookHandler.

public ref class FacebookOptions : Microsoft::AspNetCore::Authentication::OAuth::OAuthOptions

public class FacebookOptions : Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions

type FacebookOptions = class
    inherit OAuthOptions

Public Class FacebookOptions
Inherits OAuthOptions

Inheritance

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

FacebookOptions

Constructors

FacebookOptions()

Initializes a new FacebookOptions.

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)
AdditionalAuthorizationParameters	Gets the additional parameters that will be included in the authorization request. (Inherited from OAuthOptions)
AppId	Gets or sets the Facebook-assigned App ID.
AppSecret	Gets or sets the Facebook-assigned app secret.
AuthorizationEndpoint	Gets or sets the URI where the client will be redirected to authenticate. (Inherited from OAuthOptions)
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. (Inherited from OAuthOptions)
ClaimsIssuer	Gets or sets the issuer that should be used for any claims that are created (Inherited from AuthenticationSchemeOptions)
ClientId	Gets or sets the provider-assigned client id. (Inherited from OAuthOptions)
ClientSecret	Gets or sets the provider-assigned client secret. (Inherited from OAuthOptions)
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 OAuthEvents used to handle authentication events. (Inherited from OAuthOptions)
EventsType	If set, will be used as the service type to get the Events instance instead of the property. (Inherited from AuthenticationSchemeOptions)
Fields	The list of fields to retrieve from the UserInformationEndpoint.
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)
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)
Scope	Gets the list of permissions to request. (Inherited from OAuthOptions)
SendAppSecretProof	Gets or sets if the appsecret_proof should be generated and sent with Facebook API calls.
SignInScheme	Gets or sets the authentication scheme corresponding to the middleware responsible for 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)
StateDataFormat	Gets or sets the type used to secure data handled by the middleware. (Inherited from OAuthOptions)
TimeProvider	Used for testing. (Inherited from AuthenticationSchemeOptions)
TokenEndpoint	Gets or sets the URI the middleware will access to exchange the OAuth token. (Inherited from OAuthOptions)
UsePkce	Enables or disables the use of the Proof Key for Code Exchange (PKCE) standard. See https://tools.ietf.org/html/rfc7636. The default value is false but derived handlers should enable this if their provider supports it. (Inherited from OAuthOptions)
UserInformationEndpoint	Gets or sets the URI the middleware will access to obtain the user information. This value is not used in the default implementation, it is for use in custom implementations of OnCreatingTicket. (Inherited from OAuthOptions)

Methods

Validate()	Check that the options are valid. Should throw an exception if things are not ok.
Validate(String)	Checks that the options are valid for a specific scheme (Inherited from RemoteAuthenticationOptions)