oauth2Login - OAuth Login (oauth2Login)

The configuration of a generic social media login.

NameTypeDefaultDescription
idstringThe unique ID.
authorizationEndpointtokenTypeSpecifies an Authorization end point URL.
scopestringSpecifies required scope.
clientIdstringThe application or client ID.
clientSecretReversably encoded password (string)The secret of the application or client.
displayNamestringThe name of the social login configuration for display.
websitetokenTypeThe website address.
tokenEndpointtokenTypeSpecifies a token end point URL.
tokenEndpointAuthMethod
  • client_secret_post
  • client_secret_basic
client_secret_postSpecifies required authentication method.
client_secret_post
client_secret_post
client_secret_basic
client_secret_basic
sslRefA reference to top level ssl element (string).Specifies an ID of the SSL configuration that is used to connect to the social media.
authFilterRefA reference to top level authFilter element (string).Specifies the authentication filter reference.
redirectToRPHostAndPortstringSpecifies a callback host and port number.
userNameAttributetokenTypeemailThe value of the claim is authenticated user principal.
userApistringThe URL of retrieving the user information.
realmNametokenTypeThe realm name for this social media.
realmNameAttributetokenTypeThe value of the claim is used as the subject realm.
groupNameAttributetokenTypeThe value of the claim is used as the user group membership.
userUniqueIdAttributetokenTypeThe value of the claim is used as the subject uniqueId.
mapToUserRegistrybooleanfalseSpecifies whether to map userIdentifier to registry user.
isClientSideRedirectSupportedbooleantrueSpecifies 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.

authFilter

Specifies the authentication filter reference.

authFilter > webApp

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringSpecifies the name.
matchType
  • contains
  • notContain
  • equals
containsSpecifies the match type.
contains
Contains
notContain
Not contain
equals
Equals

authFilter > requestUrl

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
urlPatternstringSpecifies the URL pattern.
matchType
  • contains
  • notContain
  • equals
containsSpecifies the match type.
contains
Contains
notContain
Not contain
equals
Equals

authFilter > remoteAddress

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
matchType
  • contains
  • notContain
  • equals
  • lessThan
  • greaterThan
containsSpecifies the match type.
contains
Contains
notContain
Not contain
equals
Equals
lessThan
Less than
greaterThan
Greater than
ipstringSpecifies the IP address.

authFilter > host

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringSpecifies the name.
matchType
  • contains
  • notContain
  • equals
containsSpecifies the match type.
contains
Contains
notContain
Not contain
equals
Equals

authFilter > userAgent

A unique configuration ID.

NameTypeDefaultDescription
idstringA unique configuration ID.
agentstringSpecifies the user agent
matchType
  • contains
  • notContain
  • equals
containsSpecifies the match type.
contains
Contains
notContain
Not contain
equals
Equals

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