= Cheatsheets

[[OAuth2ClientOptions]]
== OAuth2ClientOptions

++++
Options describing how an OAuth2  will make connections.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[alpnVersions]]`@alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|-
|[[authorizationPath]]`@authorizationPath`|`String`|+++
Get the Oauth2 authorization resource path. e.g.: /oauth/authorize
+++
|[[clientID]]`@clientID`|`String`|+++
Set the provider client id
+++
|[[clientSecret]]`@clientSecret`|`String`|+++
Set the provider client secret
+++
|[[clientSecretParameterName]]`@clientSecretParameterName`|`String`|+++
Override the HTTP form field name for client secret
+++
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[decoderInitialBufferSize]]`@decoderInitialBufferSize`|`Number (int)`|-
|[[defaultHost]]`@defaultHost`|`String`|-
|[[defaultPort]]`@defaultPort`|`Number (int)`|-
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[extraParameters]]`@extraParameters`|`Json object`|+++
Set extra parameters to be sent to the provider on each request
+++
|[[flow]]`@flow`|`link:enums.html#OAuth2FlowType[OAuth2FlowType]`|-
|[[forceSni]]`@forceSni`|`Boolean`|-
|[[headers]]`@headers`|`Json object`|+++
Set custom headers to be sent with every request to the provider
+++
|[[http2ClearTextUpgrade]]`@http2ClearTextUpgrade`|`Boolean`|-
|[[http2ConnectionWindowSize]]`@http2ConnectionWindowSize`|`Number (int)`|-
|[[http2KeepAliveTimeout]]`@http2KeepAliveTimeout`|`Number (int)`|-
|[[http2MaxPoolSize]]`@http2MaxPoolSize`|`Number (int)`|-
|[[http2MultiplexingLimit]]`@http2MultiplexingLimit`|`Number (int)`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|-
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[initialSettings]]`@initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|-
|[[introspectionPath]]`@introspectionPath`|`String`|+++
Set the provider token introspection resource path
+++
|[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[jwkPath]]`@jwkPath`|`String`|-
|[[jwtOptions]]`@jwtOptions`|`link:dataobjects.html#JWTOptions[JWTOptions]`|-
|[[keepAlive]]`@keepAlive`|`Boolean`|-
|[[keepAliveTimeout]]`@keepAliveTimeout`|`Number (int)`|-
|[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[localAddress]]`@localAddress`|`String`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[logoutPath]]`@logoutPath`|`String`|+++
Set the provider logout path
+++
|[[maxChunkSize]]`@maxChunkSize`|`Number (int)`|-
|[[maxHeaderSize]]`@maxHeaderSize`|`Number (int)`|-
|[[maxInitialLineLength]]`@maxInitialLineLength`|`Number (int)`|-
|[[maxPoolSize]]`@maxPoolSize`|`Number (int)`|-
|[[maxRedirects]]`@maxRedirects`|`Number (int)`|-
|[[maxWaitQueueSize]]`@maxWaitQueueSize`|`Number (int)`|-
|[[maxWebSocketFrameSize]]`@maxWebSocketFrameSize`|`Number (int)`|-
|[[maxWebSocketMessageSize]]`@maxWebSocketMessageSize`|`Number (int)`|-
|[[maxWebsocketFrameSize]]`@maxWebsocketFrameSize`|`Number (int)`|-
|[[maxWebsocketMessageSize]]`@maxWebsocketMessageSize`|`Number (int)`|-
|[[metricsName]]`@metricsName`|`String`|-
|[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pipelining]]`@pipelining`|`Boolean`|-
|[[pipeliningLimit]]`@pipeliningLimit`|`Number (int)`|-
|[[poolCleanerPeriod]]`@poolCleanerPeriod`|`Number (int)`|-
|[[protocolVersion]]`@protocolVersion`|`link:enums.html#HttpVersion[HttpVersion]`|-
|[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[pubSecKeys]]`@pubSecKeys`|`Array of link:dataobjects.html#PubSecKeyOptions[PubSecKeyOptions]`|+++
The provider PubSec key options
+++
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[revocationPath]]`@revocationPath`|`String`|+++
Set the Oauth2 revocation resource path. e.g.: /oauth/revoke
+++
|[[scopeSeparator]]`@scopeSeparator`|`String`|+++
Set the provider scope separator
+++
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[sendUnmaskedFrames]]`@sendUnmaskedFrames`|`Boolean`|-
|[[site]]`@site`|`String`|+++
Root URL for the provider
+++
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[tcpUserTimeout]]`@tcpUserTimeout`|`Number (int)`|-
|[[tokenPath]]`@tokenPath`|`String`|+++
Get the Oauth2 token resource path. e.g.: /oauth/token
+++
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[trustAll]]`@trustAll`|`Boolean`|-
|[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[tryUseCompression]]`@tryUseCompression`|`Boolean`|-
|[[tryUsePerFrameWebSocketCompression]]`@tryUsePerFrameWebSocketCompression`|`Boolean`|-
|[[tryUsePerFrameWebsocketCompression]]`@tryUsePerFrameWebsocketCompression`|`Boolean`|-
|[[tryUsePerMessageWebSocketCompression]]`@tryUsePerMessageWebSocketCompression`|`Boolean`|-
|[[tryUsePerMessageWebsocketCompression]]`@tryUsePerMessageWebsocketCompression`|`Boolean`|-
|[[tryWebSocketDeflateFrameCompression]]`@tryWebSocketDeflateFrameCompression`|`Boolean`|-
|[[tryWebsocketDeflateFrameCompression]]`@tryWebsocketDeflateFrameCompression`|`Boolean`|-
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[useBasicAuthorizationHeader]]`@useBasicAuthorizationHeader`|`Boolean`|+++
Flag to use HTTP basic auth header with client id, client secret.
+++
|[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|-
|[[userAgent]]`@userAgent`|`String`|+++
Set a custom user agent to use when communicating to a provider
+++
|[[userInfoParameters]]`@userInfoParameters`|`Json object`|+++
Set custom parameters to be sent during the userInfo resource request
+++
|[[userInfoPath]]`@userInfoPath`|`String`|+++
Set the provider userInfo resource path
+++
|[[validateIssuer]]`@validateIssuer`|`Boolean`|-
|[[verifyHost]]`@verifyHost`|`Boolean`|-
|[[webSocketClosingTimeout]]`@webSocketClosingTimeout`|`Number (int)`|-
|[[webSocketCompressionAllowClientNoContext]]`@webSocketCompressionAllowClientNoContext`|`Boolean`|-
|[[webSocketCompressionLevel]]`@webSocketCompressionLevel`|`Number (int)`|-
|[[webSocketCompressionRequestServerNoContext]]`@webSocketCompressionRequestServerNoContext`|`Boolean`|-
|[[websocketCompressionAllowClientNoContext]]`@websocketCompressionAllowClientNoContext`|`Boolean`|-
|[[websocketCompressionLevel]]`@websocketCompressionLevel`|`Number (int)`|-
|[[websocketCompressionRequestServerNoContext]]`@websocketCompressionRequestServerNoContext`|`Boolean`|-
|===