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

SecuritySchemeBuilder

class SecuritySchemeBuilder : SecuritySchemeDsl, Builder<SecurityScheme> , Buildable<SecurityScheme>

Builder for the security scheme DSL.

Constructors

constructor()

Functions

build

open override fun build(): SecurityScheme

Build the object.

Properties

apiKeyType

val SecuritySchemeDsl.apiKeyType: Unit

Sets the type of this security scheme to API key.

bearerFormat

open override var bearerFormat: String?

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?

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

flows

open override var flows: OAuthFlows?

An object containing configuration information for the flow types supported.

httpType

val SecuritySchemeDsl.httpType: Unit

Sets the type of this security scheme to HTTP.

inCookie

val SecuritySchemeDsl.inCookie: Unit

Sets the location of this security scheme to be in a cookie.

inHeader

val SecuritySchemeDsl.inHeader: Unit

Sets the location of this security scheme to be in a header.

inLocation

open override var inLocation: SecurityScheme.In?

The location of the API key.

inQuery

val SecuritySchemeDsl.inQuery: Unit

Sets the location of this security scheme to be in a query parameter.

mutualTlsType

val SecuritySchemeDsl.mutualTlsType: Unit

Sets the type of this security scheme to Mutual TLS.

name

open override var name: String?

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

oauth2Type

val SecuritySchemeDsl.oauth2Type: Unit

Sets the type of this security scheme to OAuth 2.

openIdConnectType

val SecuritySchemeDsl.openIdConnectType: Unit

Sets the type of this security scheme to OpenID Connect.

openIdConnectUrl

open override var openIdConnectUrl: String?

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?

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?

The type of the security scheme.