SecuritySchemeDsl

interface SecuritySchemeDsl

DSL for the security scheme object.

Properties

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract var description: String?

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

Link copied to clipboard
abstract var flows: OAuthFlows?

An object containing configuration information for the flow types supported.

Link copied to clipboard
abstract var inLocation: SecurityScheme.In?

The location of the API key.

Link copied to clipboard
abstract var name: String?

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

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract var type: SecurityScheme.Type?

The type of the security scheme.

Inheritors

Link copied to clipboard

Extensions

Link copied to clipboard
val SecuritySchemeDsl.apiKeyType: Unit

Sets the type of this security scheme to API key.

Link copied to clipboard
val SecuritySchemeDsl.httpType: Unit

Sets the type of this security scheme to HTTP.

Link copied to clipboard
val SecuritySchemeDsl.inCookie: Unit

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

Link copied to clipboard
val SecuritySchemeDsl.inHeader: Unit

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

Link copied to clipboard
val SecuritySchemeDsl.inQuery: Unit

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

Link copied to clipboard
val SecuritySchemeDsl.mutualTlsType: Unit

Sets the type of this security scheme to Mutual TLS.

Link copied to clipboard
val SecuritySchemeDsl.oauth2Type: Unit

Sets the type of this security scheme to OAuth 2.

Link copied to clipboard
val SecuritySchemeDsl.openIdConnectType: Unit

Sets the type of this security scheme to OpenID Connect.