AuthScheme
How a service expects a tool to authenticate, such as with an API key, an HTTP credential or OAuth2. Most schemes match OpenAPI security schemes; OpenIdConnect gives a provider's endpoints directly.
Inheritors
Types
Link copied to clipboard
data class ApiKey(val name: String, val location: AuthScheme.ApiKey.Location, val description: String? = null) : AuthScheme
An API key scheme: where the key is sent, and under which name.
Link copied to clipboard
data class Http(val scheme: String, val bearerFormat: String? = null, val description: String? = null) : AuthScheme
An HTTP authentication scheme, such as basic or bearer.
Link copied to clipboard
data class OAuth2(val flows: AuthScheme.OAuth2.Flows, val issuerUrl: String? = null, val description: String? = null) : AuthScheme
An OAuth2 scheme: the flows the service supports, with their endpoints and scopes.
Link copied to clipboard
data class OpenIdConnect(val authorizationEndpoint: String, val tokenEndpoint: String, val userinfoEndpoint: String? = null, val revocationEndpoint: String? = null, val tokenEndpointAuthMethodsSupported: List<String>? = null, val grantTypesSupported: List<String>? = null, val scopes: List<String>? = null, val description: String? = null) : AuthScheme
An OpenID Connect scheme with the provider's endpoints given directly.
Link copied to clipboard
data class OpenIdConnectUrl(val openIdConnectUrl: String, val description: String? = null) : AuthScheme
An OpenID Connect scheme given by the provider's discovery URL.