FacebookOptions Class

Definition

Namespace:

Microsoft.AspNetCore.Builder

Assembly:

Microsoft.AspNetCore.Authentication.Facebook.dll

Package:

Microsoft.AspNetCore.Authentication.Facebook v1.1.0

Configuration options for FacebookMiddleware.

public ref class FacebookOptions : Microsoft::AspNetCore::Builder::OAuthOptions

public class FacebookOptions : Microsoft.AspNetCore.Builder.OAuthOptions

type FacebookOptions = class
    inherit OAuthOptions

Public Class FacebookOptions
Inherits OAuthOptions

Inheritance

Object

AuthenticationOptions

RemoteAuthenticationOptions

OAuthOptions

FacebookOptions

Constructors

FacebookOptions()

Initializes a new FacebookOptions.

Properties

AppId	Gets or sets the Facebook-assigned appId.
AppSecret	Gets or sets the Facebook-assigned app secret.
AuthenticationScheme	The AuthenticationScheme in the options corresponds to the logical name for a particular authentication scheme. A different value may be assigned in order to use the same authentication middleware type more than once in a pipeline. (Inherited from AuthenticationOptions)
AuthorizationEndpoint	Gets or sets the URI where the client will be redirected to authenticate. (Inherited from OAuthOptions)
AutomaticAuthenticate	If true the authentication middleware alter the request user coming in. If false the authentication middleware will only provide identity when explicitly indicated by the AuthenticationScheme. (Inherited from AuthenticationOptions)
AutomaticChallenge	If true the authentication middleware should handle automatic challenge. If false the authentication middleware will only alter responses when explicitly indicated by the AuthenticationScheme. (Inherited from AuthenticationOptions)
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)
ClaimsIssuer	Gets or sets the issuer that should be used for any claims that are created (Inherited from AuthenticationOptions)
ClientId	Gets or sets the provider-assigned client id. (Inherited from OAuthOptions)
ClientSecret	Gets or sets the provider-assigned client secret. (Inherited from OAuthOptions)
Description	Additional information about the authentication type which is made available to the application. (Inherited from AuthenticationOptions)
DisplayName	Get or sets the text that the user can display on a sign in user interface. (Inherited from RemoteAuthenticationOptions)
Events	Gets or sets the IOAuthEvents used to handle authentication events. (Inherited from OAuthOptions)
Fields	The list of fields to retrieve from the UserInformationEndpoint. https://developers.facebook.com/docs/graph-api/reference/user
RemoteAuthenticationTimeout	Gets or sets the time limit for completing the authentication flow (15 minutes by default). (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. This is enabled by default.
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, SignInScheme 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)
SystemClock	For testing purposes only. (Inherited from OAuthOptions)
TokenEndpoint	Gets or sets the URI the middleware will access to exchange the OAuth token. (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 IOAuthAuthenticationEvents.Authenticated or OAuthAuthenticationHandler.CreateTicketAsync. (Inherited from OAuthOptions)