fun oAuth2OptionsOf(authorizationPath: String? = null, clientID: String? = null, clientSecret: String? = null, clientSecretParameterName: String? = null, extraParameters: JsonObject? = null, flow: OAuth2FlowType? = null, headers: JsonObject? = null, httpClientOptions: HttpClientOptions? = null, introspectionPath: String? = null, jwkPath: String? = null, jwtOptions: JWTOptions? = null, logoutPath: String? = null, pubSecKeys: Iterable<PubSecKeyOptions>? = null, revocationPath: String? = null, scopeSeparator: String? = null, site: String? = null, tenant: String? = null, tokenPath: String? = null, useBasicAuthorizationHeader: Boolean? = null, userAgent: String? = null, userInfoParameters: JsonObject? = null, userInfoPath: String? = null, validateIssuer: Boolean? = null): OAuth2Options
A function providing a DSL for building io.vertx.ext.auth.oauth2.OAuth2Options objects.
Options describing how an OAuth2 will make connections.
authorizationPath
- Get the Oauth2 authorization resource path. e.g.: /oauth/authorize
clientID
- Set the provider client id
clientSecret
- Set the provider client secret
clientSecretParameterName
- Override the HTTP form field name for client secret
extraParameters
- Set extra parameters to be sent to the provider on each request
headers
- Set custom headers to be sent with every request to the provider
introspectionPath
- Set the provider token introspection resource path
logoutPath
- Set the provider logout path
pubSecKeys
- The provider PubSec key options
revocationPath
- Set the Oauth2 revocation resource path. e.g.: /oauth/revoke
scopeSeparator
- Set the provider scope separator
site
- Root URL for the provider without trailing slashes
tenant
- 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
- Get the Oauth2 token resource path. e.g.: /oauth/token
useBasicAuthorizationHeader
- Flag to use HTTP basic auth header with client id, client secret.
userAgent
- Set a custom user agent to use when communicating to a provider
userInfoParameters
- Set custom parameters to be sent during the userInfo resource request