OAuth Login (oauth2Login)

The configuration of a generic social media login.

NameTypeDefaultDescription

authFilterRef

A reference to top level authFilter element (string).

Specifies the authentication filter reference.

authorizationEndpoint

tokenType

Specifies an Authorization end point URL.

clientId

string

The application or client ID.

clientSecret

Reversably encoded password (string)

The secret of the application or client.

displayName

string

The name of the social login configuration for display.

groupNameAttribute

tokenType

The value of the claim is used as the user group membership.

id

string

The unique ID.

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.

realmName

tokenType

The realm name for this social media.

realmNameAttribute

tokenType

The value of the claim is used as the subject realm.

redirectToRPHostAndPort

string

Specifies a callback host and port number.

scope

string

Specifies required scope.

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

tokenType

Specifies a token end point URL.

tokenEndpointAuthMethod

  • client_secret_basic

  • client_secret_post

client_secret_post

Specifies required authentication method.

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

The URL of retrieving the user information.

userNameAttribute

tokenType

email

The value of the claim is authenticated user principal.

userUniqueIdAttribute

tokenType

The value of the claim is used as the subject uniqueId.

website

tokenType

The website address.

authFilter

Specifies the authentication filter reference.

authFilter > host

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

name

string

Specifies the name.

authFilter > remoteAddress

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

ip

string

Specifies the IP address.

matchType

  • contains

  • equals

  • greaterThan

  • lessThan

  • notContain

contains

Specifies the match type.

authFilter > requestUrl

A unique configuration ID.

NameTypeDefaultDescription

id

string

A unique configuration ID.

matchType

  • contains

  • equals

  • notContain

contains

Specifies the match type.

urlPattern

string

Specifies the URL pattern.

authFilter > userAgent

A unique configuration ID.

NameTypeDefaultDescription

agent

string

Specifies the user agent

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

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

tokenType

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

jwt > claims

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