Options describing how an OAuth2 will make connections.

  • OAuth2ClientOptions
    • BaseDataObject
    • HttpClientOptions
      • BaseDataObject
      • ClientOptionsBase
        • BaseDataObject
        • TCPSSLOptions
          • BaseDataObject
          • NetworkOptions
            • BaseDataObject
            • Basic
              • Identifiable
              • Object
                • Anything

no subtypes hierarchy

Initializer
OAuth2ClientOptions({HttpVersion*}? alpnVersions = null, String? authorizationPath = null, String? clientID = null, String? clientSecret = null, String? clientSecretParameterName = null, Integer? connectTimeout = null, {String*}? crlPaths = null, Integer? decoderInitialBufferSize = null, String? defaultHost = null, Integer? defaultPort = null, {String*}? enabledCipherSuites = null, {String*}? enabledSecureTransportProtocols = null, JsonObject? extraParameters = null, Boolean? forceSni = null, JsonObject? headers = null, Boolean? http2ClearTextUpgrade = null, Integer? http2ConnectionWindowSize = null, Integer? http2MaxPoolSize = null, Integer? http2MultiplexingLimit = null, Integer? idleTimeout = null, Http2Settings? initialSettings = null, String? introspectionPath = null, JdkSSLEngineOptions? jdkSslEngineOptions = null, Boolean? jwtToken = null, Boolean? keepAlive = null, JksOptions? keyStoreOptions = null, String? localAddress = null, Boolean? logActivity = null, String? logoutPath = null, Integer? maxChunkSize = null, Integer? maxHeaderSize = null, Integer? maxInitialLineLength = null, Integer? maxPoolSize = null, Integer? maxRedirects = null, Integer? maxWaitQueueSize = null, Integer? maxWebsocketFrameSize = null, Integer? maxWebsocketMessageSize = null, String? metricsName = null, OpenSSLEngineOptions? openSslEngineOptions = null, PemKeyCertOptions? pemKeyCertOptions = null, PemTrustOptions? pemTrustOptions = null, PfxOptions? pfxKeyCertOptions = null, PfxOptions? pfxTrustOptions = null, Boolean? pipelining = null, Integer? pipeliningLimit = null, HttpVersion? protocolVersion = null, ProxyOptions? proxyOptions = null, PubSecKeyOptions? pubSecKey = null, PubSecKeyOptions? pubSecKeyOptions = null, Integer? receiveBufferSize = null, Boolean? reuseAddress = null, Boolean? reusePort = null, String? revocationPath = null, String? scopeSeparator = null, Integer? sendBufferSize = null, Boolean? sendUnmaskedFrames = null, String? site = null, Integer? soLinger = null, Boolean? ssl = null, Boolean? tcpCork = null, Boolean? tcpFastOpen = null, Boolean? tcpKeepAlive = null, Boolean? tcpNoDelay = null, Boolean? tcpQuickAck = null, String? tokenPath = null, Integer? trafficClass = null, Boolean? trustAll = null, JksOptions? trustStoreOptions = null, Boolean? tryUseCompression = null, Boolean? useAlpn = null, Boolean? useBasicAuthorizationHeader = null, Boolean? usePooledBuffers = null, String? userAgent = null, JsonObject? userInfoParameters = null, String? userInfoPath = null, Boolean? verifyHost = null)
Parameters:
  • alpnVersions = null
  • authorizationPath = null

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

  • clientID = null

    Set the provider client id

  • clientSecret = null

    Set the provider client secret

  • clientSecretParameterName = null

    Override the HTTP form field name for client secret

  • connectTimeout = null
  • crlPaths = null
  • decoderInitialBufferSize = null
  • defaultHost = null
  • defaultPort = null
  • enabledCipherSuites = null
  • enabledSecureTransportProtocols = null
  • extraParameters = null

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

  • forceSni = null
  • headers = null

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

  • http2ClearTextUpgrade = null
  • http2ConnectionWindowSize = null
  • http2MaxPoolSize = null
  • http2MultiplexingLimit = null
  • idleTimeout = null
  • initialSettings = null
  • introspectionPath = null

    Set the provider token introspection resource path

  • jdkSslEngineOptions = null
  • jwtToken = null

    Signal that this provider tokens are in JWT format

  • keepAlive = null
  • keyStoreOptions = null
  • localAddress = null
  • logActivity = null
  • logoutPath = null

    Set the provider logout path

  • maxChunkSize = null
  • maxHeaderSize = null
  • maxInitialLineLength = null
  • maxPoolSize = null
  • maxRedirects = null
  • maxWaitQueueSize = null
  • maxWebsocketFrameSize = null
  • maxWebsocketMessageSize = null
  • metricsName = null
  • openSslEngineOptions = null
  • pemKeyCertOptions = null
  • pemTrustOptions = null
  • pfxKeyCertOptions = null
  • pfxTrustOptions = null
  • pipelining = null
  • pipeliningLimit = null
  • protocolVersion = null
  • proxyOptions = null
  • pubSecKey = null

    The provider PubSec key options

  • pubSecKeyOptions = null
  • receiveBufferSize = null
  • reuseAddress = null
  • reusePort = null
  • revocationPath = null

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

  • scopeSeparator = null

    Set the provider scope separator

  • sendBufferSize = null
  • sendUnmaskedFrames = null
  • site = null

    Root URL for the provider

  • soLinger = null
  • ssl = null
  • tcpCork = null
  • tcpFastOpen = null
  • tcpKeepAlive = null
  • tcpNoDelay = null
  • tcpQuickAck = null
  • tokenPath = null

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

  • trafficClass = null
  • trustAll = null
  • trustStoreOptions = null
  • tryUseCompression = null
  • useAlpn = null
  • useBasicAuthorizationHeader = null

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

  • usePooledBuffers = null
  • userAgent = null

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

  • userInfoParameters = null

    Set custom parameters to be sent during the userInfo resource request

  • userInfoPath = null

    Set the provider userInfo resource path

  • verifyHost = null
Attributes
authorizationPathshared String? authorizationPath

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

clientIDshared String? clientID

Set the provider client id

clientSecretshared String? clientSecret

Set the provider client secret

clientSecretParameterNameshared String? clientSecretParameterName

Override the HTTP form field name for client secret

extraParametersshared JsonObject? extraParameters

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

headersshared JsonObject? headers

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

introspectionPathshared String? introspectionPath

Set the provider token introspection resource path

jwtTokenshared Boolean? jwtToken

Signal that this provider tokens are in JWT format

logoutPathshared String? logoutPath

Set the provider logout path

pubSecKeyshared PubSecKeyOptions? pubSecKey

The provider PubSec key options

pubSecKeyOptionsshared PubSecKeyOptions? pubSecKeyOptions
revocationPathshared String? revocationPath

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

scopeSeparatorshared String? scopeSeparator

Set the provider scope separator

siteshared String? site

Root URL for the provider

tokenPathshared String? tokenPath

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

useBasicAuthorizationHeadershared Boolean? useBasicAuthorizationHeader

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

userAgentshared String? userAgent

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

userInfoParametersshared JsonObject? userInfoParameters

Set custom parameters to be sent during the userInfo resource request

userInfoPathshared String? userInfoPath

Set the provider userInfo resource path

Inherited Attributes
Attributes inherited from: ClientOptionsBase
connectTimeout, localAddress, metricsName, proxyOptions, trustAll
Attributes inherited from: HttpClientOptions
alpnVersions, decoderInitialBufferSize, defaultHost, defaultPort, forceSni, http2ClearTextUpgrade, http2ConnectionWindowSize, http2MaxPoolSize, http2MultiplexingLimit, initialSettings, keepAlive, maxChunkSize, maxHeaderSize, maxInitialLineLength, maxPoolSize, maxRedirects, maxWaitQueueSize, maxWebsocketFrameSize, maxWebsocketMessageSize, pipelining, pipeliningLimit, protocolVersion, sendUnmaskedFrames, tryUseCompression, verifyHost
Attributes inherited from: NetworkOptions
logActivity, receiveBufferSize, reuseAddress, reusePort, sendBufferSize, trafficClass
Attributes inherited from: Object
hash, string
Attributes inherited from: TCPSSLOptions
crlPaths, enabledCipherSuites, enabledSecureTransportProtocols, idleTimeout, jdkSslEngineOptions, keyStoreOptions, openSslEngineOptions, pemKeyCertOptions, pemTrustOptions, pfxKeyCertOptions, pfxTrustOptions, soLinger, ssl, tcpCork, tcpFastOpen, tcpKeepAlive, tcpNoDelay, tcpQuickAck, trustStoreOptions, useAlpn, usePooledBuffers
Methods
toJsonshared actual default JsonObject toJson()
Refines HttpClientOptions.toJson ultimately refines BaseDataObject.toJson
Inherited Methods
Methods inherited from: ClientOptionsBase
toJson
Methods inherited from: HttpClientOptions
toJson
Methods inherited from: NetworkOptions
toJson
Methods inherited from: Object
equals
Methods inherited from: TCPSSLOptions
toJson
Methods inherited from: BaseDataObject
toJson