githubLogin - GitHub Social Login (githubLogin)

The configuration of the social login for GitHub.

NameTypeDefaultDescription
idstringA unique configuration ID.
clientIdstringThe application or client ID.
clientSecretReversably encoded password (string)The secret of the application or client.
authorizationEndpointstringhttps://github.com/login/oauth/authorizeSpecifies an Authorization end point URL.
tokenEndpointstringhttps://github.com/login/oauth/access_tokenSpecifies a token end point URL.
userApistringhttps://api.github.com/user/emailsThe URL of retrieving the user information.
scopestringuserSpecifies required scope.
userNameAttributestringemailThe value of the claim is authenticated user principal.
mapToUserRegistrybooleanfalseSpecifies whether to map userIdentifier to registry user.
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.
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.
displayNamestringGitHubThe name of the social login configuration for display.
websitetokenTypehttps://github.comThe website address.
redirectToRPHostAndPortstringSpecifies a callback host and port number.

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.