OAuth2Options

Options describing how an OAuth2 will make connections.

Name

Type

Description

@authorizationPath

String

Get the Oauth2 authorization resource path. e.g.: /oauth/authorize

@clientID

String

Set the provider client id

@clientSecret

String

Set the provider client secret

@clientSecretParameterName

String

Override the HTTP form field name for client secret

@extraParameters

Json object

Set extra parameters to be sent to the provider on each request

@flow

OAuth2FlowType

-

@headers

Json object

Set custom headers to be sent with every request to the provider

@introspectionPath

String

Set the provider token introspection resource path

@jwkPath

String

-

@logoutPath

String

Set the provider logout path

@revocationPath

String

Set the Oauth2 revocation resource path. e.g.: /oauth/revoke

@scopeSeparator

String

Set the provider scope separator

@site

String

Root URL for the provider without trailing slashes

@tenant

String

Sets an optional tenant. Tenants are used in some OpenID servers as placeholders for the URLs. The tenant should be set prior to any URL as it affects the way the URLs will be stored.

Some provders may name this differently, for example: `realm`.

@tokenPath

String

Get the Oauth2 token resource path. e.g.: /oauth/token

@useBasicAuthorizationHeader

Boolean

Flag to use HTTP basic auth header with client id, client secret.

@userAgent

String

Set a custom user agent to use when communicating to a provider

@userInfoParameters

Json object

Set custom parameters to be sent during the userInfo resource request

@userInfoPath

String

Set the provider userInfo resource path

@validateIssuer

Boolean

-

Oauth2Credentials

Credentials specific to the link provider

Name

Type

Description

@code

String

-

@extra

Json object

-

@redirectUri

String

-