SecurityScheme

zio.http.api.openapi.OpenAPI$.SecurityScheme$

See theSecurityScheme companion trait

Attributes

Concise view

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

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
Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait SecurityScheme
trait SecuritySchemeOrReference
class Object
trait Matchable
class Any

Companion:: class
Graph
Supertypes: trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type: ApiKey.type

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.
Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait SecurityScheme
trait SecuritySchemeOrReference
class Object
trait Matchable
class Any

description: A short description for security scheme.
flows: An object containing configuration information for the flow types supported.
Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait SecurityScheme
trait SecuritySchemeOrReference
class Object
trait Matchable
class Any

description: A short description for security scheme.
openIdConnectUrl: OpenId Connect URL to discover OAuth2 configuration values.
Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait SecurityScheme
trait SecuritySchemeOrReference
class Object
trait Matchable
class Any

The names of the product elements

The name of the type

Generated with