Twitter Social Login (twitterLogin)

The configuration of the social login for Twitter.

Name	Type	Default	Description
accessTokenUrl	string	https://api.twitter.com/oauth/access_token	The token end point URL of Twitter.
authFilterRef	A reference to top level authFilter element (string).		Specifies the authentication filter reference.
consumerKey	string Required		Consumer key issued by Twitter.
consumerSecret	Reversably encoded password (string) Required		Consumer secret issued by Twitter.
displayName	string	Twitter	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.
mapToUserRegistry	boolean	false	Specifies whether to map userIdentifier to registry user.
redirectToRPHostAndPort	string		Specifies a callback protocol, host, and port number. For example, https://myhost:8020.
requestTokenUrl	string	https://api.twitter.com/oauth/request_token	The request token endpoint of Twitter.
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.
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://api.twitter.com/1.1/account/verify_credentials.json	The URL of retrieving the user information.
userAuthorizationUrl	string	https://api.twitter.com/oauth/authenticate	The user authorization end point URL of Twitter.
userNameAttribute	string	email	The value of the claim is authenticated user principal.
website	string (with whitespace trimmed off)	https://twitter.com	The website address.

Name

Type

Default

Description

accessTokenUrl

string

https://api.twitter.com/oauth/access_token

The token end point URL of Twitter.

authFilterRef

A reference to top level authFilter element (string).

Specifies the authentication filter reference.

consumerKey

string
Required

Consumer key issued by Twitter.

consumerSecret

Reversably encoded password (string)
Required

Consumer secret issued by Twitter.

displayName

string

Twitter

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.

mapToUserRegistry

boolean

false

Specifies whether to map userIdentifier to registry user.

redirectToRPHostAndPort

string

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

requestTokenUrl

string

https://api.twitter.com/oauth/request_token

The request token endpoint of Twitter.

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.

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://api.twitter.com/1.1/account/verify_credentials.json

The URL of retrieving the user information.

userAuthorizationUrl

string

https://api.twitter.com/oauth/authenticate

The user authorization end point URL of Twitter.

userNameAttribute

string

The value of the claim is authenticated user principal.

website

string (with whitespace trimmed off)

https://twitter.com

The website address.

twitterLogin > authFilter

Specifies the authentication filter reference.

twitterLogin > authFilter > cookie

A unique configuration ID.

Name	Type	Default	Description
id	string		A unique configuration ID.
matchType	contains equals notContain	contains	Specifies the match type.
name	string Required		Specifies the name.

twitterLogin > authFilter > host

A unique configuration ID.

Name	Type	Default	Description
id	string		A unique configuration ID.
matchType	contains equals notContain	contains	Specifies the match type.
name	string Required		Specifies the name.

twitterLogin > authFilter > remoteAddress

A unique configuration ID.

Name	Type	Default	Description
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.

twitterLogin > authFilter > requestHeader

A unique configuration ID.

Name	Type	Default	Description
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".

twitterLogin > authFilter > requestUrl

A unique configuration ID.

Name	Type	Default	Description
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.

twitterLogin > authFilter > userAgent

A unique configuration ID.

Name	Type	Default	Description
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.

twitterLogin > authFilter > webApp

A unique configuration ID.

Name	Type	Default	Description
id	string		A unique configuration ID.
matchType	contains equals notContain	contains	Specifies the match type.
name	string Required		Specifies the name.

twitterLogin > 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.

Name	Type	Default	Description
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.

Name

Type

Default

Description

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.