ktor-openapi-schema/io.ktor.openapi/OAuthFlow

OAuthFlow

@Serializable(with = OAuthFlow.Companion.Serializer::class)

data class OAuthFlow(val authorizationUrl: String? = null, val tokenUrl: String? = null, val refreshUrl: String? = null, val scopes: Map<String, String>? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

Configuration details for a supported OAuth Flow.

Report a problem

Constructors

constructor(authorizationUrl: String? = null, tokenUrl: String? = null, refreshUrl: String? = null, scopes: Map<String, String>? = null, extensions: ExtensionProperties? = null)

Types

object Companion

Properties

authorizationUrl

val authorizationUrl: String?

The authorization URL to be used for this flow (oauth2 implicit and authorizationCode flows).

open override val extensions: ExtensionProperties?

Specification-extensions for this object (keys must start with x-).

val refreshUrl: String?

The URL to be used for getting refresh tokens.

val scopes: Map<String, String>?

The available scopes for the OAuth2 security scheme.

val tokenUrl: String?

The token URL to be used for this flow (oauth2 password, clientCredentials, and authorizationCode flows).