Options describing how an OAuth2 will make connections.
Name |
Type |
Description |
alpnVersions
|
Array of HttpVersion
|
- |
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 |
connectTimeout
|
Number (int)
|
- |
crlPaths
|
Array of String
|
- |
crlValues
|
Array of Buffer
|
- |
decoderInitialBufferSize
|
Number (int)
|
- |
defaultHost
|
String
|
- |
defaultPort
|
Number (int)
|
- |
enabledCipherSuites
|
Array of String
|
- |
enabledSecureTransportProtocols
|
Array of String
|
- |
extraParameters
|
Json object
|
Set extra parameters to be sent to the provider on each request |
forceSni
|
Boolean
|
- |
headers
|
Json object
|
Set custom headers to be sent with every request to the provider |
http2ClearTextUpgrade
|
Boolean
|
- |
http2ConnectionWindowSize
|
Number (int)
|
- |
http2MaxPoolSize
|
Number (int)
|
- |
http2MultiplexingLimit
|
Number (int)
|
- |
idleTimeout
|
Number (int)
|
- |
initialSettings
|
Http2Settings
|
- |
introspectionPath
|
String
|
Set the provider token introspection resource path |
jdkSslEngineOptions
|
JdkSSLEngineOptions
|
- |
jwtToken
|
Boolean
|
Signal that this provider tokens are in JWT format |
keepAlive
|
Boolean
|
- |
keyStoreOptions
|
JksOptions
|
- |
localAddress
|
String
|
- |
logActivity
|
Boolean
|
- |
logoutPath
|
String
|
Set the provider logout path |
maxChunkSize
|
Number (int)
|
- |
maxHeaderSize
|
Number (int)
|
- |
maxInitialLineLength
|
Number (int)
|
- |
maxPoolSize
|
Number (int)
|
- |
maxRedirects
|
Number (int)
|
- |
maxWaitQueueSize
|
Number (int)
|
- |
maxWebsocketFrameSize
|
Number (int)
|
- |
maxWebsocketMessageSize
|
Number (int)
|
- |
metricsName
|
String
|
- |
openSslEngineOptions
|
OpenSSLEngineOptions
|
- |
pemKeyCertOptions
|
PemKeyCertOptions
|
- |
pemTrustOptions
|
PemTrustOptions
|
- |
pfxKeyCertOptions
|
PfxOptions
|
- |
pfxTrustOptions
|
PfxOptions
|
- |
pipelining
|
Boolean
|
- |
pipeliningLimit
|
Number (int)
|
- |
protocolVersion
|
HttpVersion
|
- |
proxyOptions
|
ProxyOptions
|
- |
pubSecKey
|
PubSecKeyOptions
|
The provider PubSec key options |
pubSecKeyOptions
|
PubSecKeyOptions
|
- |
receiveBufferSize
|
Number (int)
|
- |
reuseAddress
|
Boolean
|
- |
reusePort
|
Boolean
|
- |
revocationPath
|
String
|
Set the Oauth2 revocation resource path. e.g.: /oauth/revoke |
scopeSeparator
|
String
|
Set the provider scope separator |
sendBufferSize
|
Number (int)
|
- |
sendUnmaskedFrames
|
Boolean
|
- |
site
|
String
|
Root URL for the provider |
soLinger
|
Number (int)
|
- |
ssl
|
Boolean
|
- |
tcpCork
|
Boolean
|
- |
tcpFastOpen
|
Boolean
|
- |
tcpKeepAlive
|
Boolean
|
- |
tcpNoDelay
|
Boolean
|
- |
tcpQuickAck
|
Boolean
|
- |
tokenPath
|
String
|
Get the Oauth2 token resource path. e.g.: /oauth/token |
trafficClass
|
Number (int)
|
- |
trustAll
|
Boolean
|
- |
trustStoreOptions
|
JksOptions
|
- |
tryUseCompression
|
Boolean
|
- |
useAlpn
|
Boolean
|
- |
useBasicAuthorizationHeader
|
Boolean
|
Flag to use HTTP basic auth header with client id, client secret. |
usePooledBuffers
|
Boolean
|
- |
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 |
verifyHost
|
Boolean
|
- |