Flow

sealed interface Flow

An OAuth2 flow: its endpoints and the scopes to request.

Inheritors

Types

Link copied to clipboard
data class AuthorizationCode(val authorizationUrl: String, val tokenUrl: String, val refreshUrl: String? = null, val scopes: Map<String, String> = emptyMap()) : AuthScheme.OAuth2.Flow

The authorization code flow.

Link copied to clipboard
data class ClientCredentials(val tokenUrl: String, val refreshUrl: String? = null, val scopes: Map<String, String> = emptyMap()) : AuthScheme.OAuth2.Flow

The client credentials flow.

Link copied to clipboard
data class Implicit(val authorizationUrl: String, val refreshUrl: String? = null, val scopes: Map<String, String> = emptyMap()) : AuthScheme.OAuth2.Flow

The implicit flow.

Link copied to clipboard
data class Password(val tokenUrl: String, val refreshUrl: String? = null, val scopes: Map<String, String> = emptyMap()) : AuthScheme.OAuth2.Flow

The resource owner password flow.

Properties

Link copied to clipboard
abstract val refreshUrl: String?

The endpoint for refreshing tokens.

Link copied to clipboard
abstract val scopes: Map<String, String>

The scopes to request, each mapped to its description.