ktor-server-auth/io.ktor.server.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

OAuth2 server settings

Constructors

OAuth2ServerSettings

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 = {})

Properties

accessTokenInterceptor

val accessTokenInterceptor: HttpRequestBuilder.() -> Unit

an interceptor function to customize access token request

accessTokenRequiresBasicAuth

val accessTokenRequiresBasicAuth: Boolean = false

to send BASIC auth header when an access token is requested

val accessTokenUrl: String

OAuth server access token request URL

val authorizeUrl: String

OAuth server authorization page URL

authorizeUrlInterceptor

val authorizeUrlInterceptor: URLBuilder.() -> Unit

an interceptor function to customize authorization URL

val clientId: String

client id parameter (provided by OAuth server vendor)

val clientSecret: String

client secret parameter (provided by OAuth server vendor)

val defaultScopes: List<String>

OAuth scopes used by default

val name: String

configuration name

val nonceManager: NonceManager

to be used to produce and verify nonce values

passParamsInURL

val passParamsInURL: Boolean = false

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

val requestMethod: HttpMethod

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

val version: OAuthVersion

OAuth version (1a or 2)