ktor-auth/io.ktor.auth/OAuthServerSettings/OAuth2ServerSettings

OAuth2ServerSettings

class OAuth2ServerSettings(name: String, authorizeUrl: String, accessTokenUrl: String, requestMethod: HttpMethod, clientId: String, clientSecret: String, defaultScopes: List<String>, accessTokenRequiresBasicAuth: Boolean, nonceManager: NonceManager, authorizeUrlInterceptor: URLBuilder.() -> Unit, passParamsInURL: Boolean, accessTokenInterceptor: HttpRequestBuilder.() -> Unit) : OAuthServerSettings
Content copied to clipboard

OAuth2 server settings

Constructors

Link copied to clipboard
fun OAuth2ServerSettings(name: String, authorizeUrl: String, accessTokenUrl: String, requestMethod: HttpMethod = HttpMethod.Get, clientId: String, clientSecret: String, defaultScopes: List<String> = emptyList(), accessTokenRequiresBasicAuth: Boolean = false, nonceManager: NonceManager = GenerateOnlyNonceManager, authorizeUrlInterceptor: URLBuilder.() -> Unit = {}, passParamsInURL: Boolean = false)
Content copied to clipboard
Link copied to clipboard
fun OAuth2ServerSettings(name: String, authorizeUrl: String, accessTokenUrl: String, requestMethod: HttpMethod = HttpMethod.Get, clientId: String, clientSecret: String, defaultScopes: List<String> = emptyList(), accessTokenRequiresBasicAuth: Boolean = false, nonceManager: NonceManager = GenerateOnlyNonceManager, authorizeUrlInterceptor: URLBuilder.() -> Unit = {}, passParamsInURL: Boolean = false, accessTokenInterceptor: HttpRequestBuilder.() -> Unit = {})
Content copied to clipboard

Properties

Link copied to clipboard
val accessTokenInterceptor: HttpRequestBuilder.() -> Unit
Content copied to clipboard

an interceptor function to customize access token request

Link copied to clipboard
val accessTokenRequiresBasicAuth: Boolean = false
Content copied to clipboard

to send BASIC auth header when an access token is requested

Link copied to clipboard
val accessTokenUrl: String
Content copied to clipboard

OAuth server access token request URL

Link copied to clipboard
val authorizeUrl: String
Content copied to clipboard

OAuth server authorization page URL

Link copied to clipboard
val authorizeUrlInterceptor: URLBuilder.() -> Unit
Content copied to clipboard

an interceptor function to customize authorization URL

Link copied to clipboard
val clientId: String
Content copied to clipboard

client id parameter (provided by OAuth server vendor)

Link copied to clipboard
val clientSecret: String
Content copied to clipboard

client secret parameter (provided by OAuth server vendor)

Link copied to clipboard
val defaultScopes: List<String>
Content copied to clipboard

OAuth scopes used by default

Link copied to clipboard
val name: String
Content copied to clipboard

configuration name

Link copied to clipboard
val nonceManager: NonceManager
Content copied to clipboard

to be used to produce and verify nonce values

Link copied to clipboard
val passParamsInURL: Boolean = false
Content copied to clipboard

whether to pass request parameters in POST requests in URL instead of body.

Link copied to clipboard
val requestMethod: HttpMethod
Content copied to clipboard

HTTP request method to be used to acquire access token (see vendors documentation)

Link copied to clipboard
val version: OAuthVersion
Content copied to clipboard

OAuth version (1a or 2)