tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/SecuritySchemeBuilder

SecuritySchemeBuilder

class SecuritySchemeBuilder : SecuritySchemeDsl, Builder<SecurityScheme>

Builder for the security scheme DSL.

Constructors

fun SecuritySchemeBuilder()

Functions

build

open override fun build(): SecurityScheme

Build the object.

Properties

bearerFormat

open override var bearerFormat: String? = null

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

open override var description: String? = null

A description for security scheme. CommonMark syntax may be used for rich text representation.

flows

open override var flows: OAuthFlows? = null

An object containing configuration information for the flow types supported.

inLocation

open override var inLocation: SecurityScheme.In? = null

The location of the API key.

name

open override var name: String? = null

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

openIdConnectUrl

open override var openIdConnectUrl: String? = null

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.

scheme

open override var scheme: String? = null

The name of the HTTP Authorization scheme to bbe used in the Authorization header as defined in RFC 7235. The values used should be registered in the IANA Authentication Scheme registry.

type

open override var type: SecurityScheme.Type? = null

The type of the security scheme.