Facebook Social Login (facebookLogin)

The configuration of the social login for Facebook.

NameTypeDefaultDescription

authFilterRef

A reference to top level authFilter element (string).

Specifies the authentication filter reference.

clientId

string
Required

The application or client ID.

clientSecret

Reversably encoded password (string)
Required

The secret of the application or client.

displayName

string

Facebook

The name of the social login configuration for display.

isClientSideRedirectSupported

boolean

true

Specifies whether client side redirection is supported. Examples of a client include a browser or a standalone JavaScript application. If set to true, the client must support JavaScript.

loginDialogEndpoint

string

https://www.facebook.com/v2.8/dialog/oauth

The login authorization end point URL of Facebook.

mapToUserRegistry

boolean

false

Specifies whether to map userIdentifier to registry user.

permissions

string

public_profile email

Specifies the required scope from Facebook.

redirectToRPHostAndPort

string

Specifies a callback protocol, host, and port number. For example, https://myhost:8020.

responseType

  • code

code

Specifies the OAuth response type.
code
Authorization code

sslRef

A reference to top level ssl element (string).

Specifies an ID of the SSL configuration that is used to connect to the social media.

tokenEndpoint

string

https://graph.facebook.com/v2.8/oauth/access_token

Specifies a token end point URL.

tokenEndpointAuthMethod

  • client_secret_basic

  • client_secret_post

client_secret_post

Specifies required authentication method.
client_secret_basic
Use the HTTP Basic authentication scheme to authenticate the client with the token endpoint of the OpenID Connect provider.
client_secret_post
Include the client credentials in the request body to authenticate the client with the token endpoint of the OpenID Connect provider.

useSystemPropertiesForHttpClientConnections

boolean

false

Specifies whether to use Java system properties when the OpenID Connect or OAuth client creates HTTP client connections. Set this property to true if you want the connections to use the http* or javax* system properties.

userApi

string

https://graph.facebook.com/v2.8/me?fields=id,name,email

The URL of retrieving the user information.

userNameAttribute

string

email

The value of the claim is authenticated user principal.

website

string (with whitespace trimmed off)

https://www.facebook.com

The website address.

authFilter

Specifies the authentication filter reference.

authFilter > cookie

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

name

string
Required

Specifies the name.

authFilter > host

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

name

string
Required

Specifies the name.

authFilter > remoteAddress

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

ip

string

Specifies the remote host TCP/IP address.

matchType

  • contains

  • equals

  • greaterThan

  • lessThan

  • notContain

contains

Specifies the match type.

authFilter > requestHeader

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

name

string
Required

Specifies the name.

value

string

The value attribute specifies the value of the request header. If the value is not specified, then the name attribute is used for matching, for example, requestHeader id="sample" name="email" matchType="contains".

authFilter > requestUrl

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

urlPattern

string
Required

Specifies the URL pattern. The * character is not supported to be used as a wildcard.

authFilter > userAgent

A unique configuration ID.

NameTypeDefaultDescription

agent

string
Required

Specifies the browser's user agent to help identify which browser is being used.

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

authFilter > webApp

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

name

string
Required

Specifies the name.

jwt

Specifies the information that is used to build the JWT tokens. This information includes the JWT builder reference and the claims from the id token.

NameTypeDefaultDescription

builder

string (with whitespace trimmed off)

The referenced JWT builder creates a JWT token, and the token is added to the authenticated subject.

claims

string
This is specified as a child element rather than as an XML attribute (maximum occurrences 400).

Specifies a comma-separated list of claims to copy from the user information or the id token.