docs
API
Generated with
docs/zio.http/zio.http.endpoint/zio.http.endpoint.openapi/OpenAPI/SecurityScheme

SecurityScheme

zio.http.endpoint.openapi.OpenAPI$.SecurityScheme$
See theSecurityScheme companion trait
object SecurityScheme

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiKey

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ApiKey.type
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Generated with