SecurityScheme

zio.blocks.openapi.SecurityScheme

See theSecurityScheme companion trait

Attributes

Companion: trait
Source: OpenAPI.scala
Graph
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: SecurityScheme.type

API key authentication.

description: A description for security scheme. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
in: REQUIRED. The location of the API key.
name: REQUIRED. The name of the header, query or cookie parameter to be used.

Source: OpenAPI.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait SecurityScheme

class Object

trait Matchable

class Any
Show all

HTTP authentication scheme (Bearer, Basic, etc.).

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 description for security scheme. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
scheme: REQUIRED. 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.

Source: OpenAPI.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait SecurityScheme

class Object

trait Matchable

class Any
Show all

Mutual TLS authentication.

description: A description for security scheme. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.

Source: OpenAPI.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait SecurityScheme

class Object

trait Matchable

class Any
Show all

OAuth 2.0 authentication.

description: A description for security scheme. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
flows: REQUIRED. An object containing configuration information for the flow types supported.

Source: OpenAPI.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait SecurityScheme

class Object

trait Matchable

class Any
Show all

OpenID Connect authentication.

description: A description for security scheme. CommonMark syntax MAY be used for rich text representation.
extensions: Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
openIdConnectUrl: REQUIRED. OpenID Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS.

Source: OpenAPI.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait SecurityScheme

class Object

trait Matchable

class Any
Show all

The names of the product elements.

The name of the type.

In this article