SecurityScheme

Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any

Type members

Classlikes

final case class ApiKey(description: Doc, name: String, in: In) extends SecurityScheme

Defines an HTTP security scheme that can be used by the operations.

Defines an HTTP security scheme that can be used by the operations.

Value parameters:
description

A short description for security scheme.

in

The location of the API key.

name

The name of the header, query or cookie parameter to be used.

Companion:
object
object ApiKey
Companion:
class
final case class Http(description: Doc, scheme: String, bearerFormat: Option[String]) extends SecurityScheme
Value parameters:
bearerFormat

A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

description

A short description for security scheme.

scheme

The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.

final case class OAuth2(description: Doc, flows: OAuthFlows) extends SecurityScheme
Value parameters:
description

A short description for security scheme.

flows

An object containing configuration information for the flow types supported.

final case class OpenIdConnect(description: Doc, openIdConnectUrl: URI) extends SecurityScheme
Value parameters:
description

A short description for security scheme.

openIdConnectUrl

OpenId Connect URL to discover OAuth2 configuration values.

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror

The name of the type

The name of the type

Inherited from:
Mirror