HttpSecurityScheme

data class HttpSecurityScheme(val scheme: String? = null, val bearerFormat: String? = null, val description: String? = null, val extensions: ExtensionProperties? = null) : SecurityScheme, Extensible(source)

Describes an HTTP-based security scheme.

Constructors

constructor(scheme: String? = null, bearerFormat: String? = null, description: String? = null, extensions: ExtensionProperties? = null)

A hint to the client to identify how the bearer token is formatted.

open override val description: String?

A short description for a security scheme.

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

The name of the HTTP Authorization scheme.

The type of the security scheme (SecuritySchemeType.HTTP).