ktor-openapi-schema/io.ktor.openapi/ApiKeySecurityScheme

ApiKeySecurityScheme

@Serializable(with = ApiKeySecurityScheme.Companion.Serializer::class)

data class ApiKeySecurityScheme(val name: String? = null, val in: SecuritySchemeIn? = null, val description: String? = null, val extensions: ExtensionProperties? = null) : SecurityScheme, Extensible(source)

Describes an API Key-based security scheme for OpenAPI 3.0+ specifications.

The API Key security scheme is used to authenticate requests using a single static API key that can be passed in a header, query parameter, or cookie.

Report a problem

Constructors

ApiKeySecurityScheme

constructor(name: String? = null, in: SecuritySchemeIn? = null, description: String? = null, extensions: ExtensionProperties? = null)

Types

Companion

object Companion

Properties

description

open override val description: String?

A short description for this security scheme.

extensions

open override val extensions: ExtensionProperties?

Specification-extensions for this security scheme (keys must start with x-).

val in: SecuritySchemeIn?

The location where the API key is passed (query, header, or cookie).

name

val name: String?

The name of the header, query, or cookie parameter containing the API key.

type

@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)

open override val type: SecuritySchemeType

The type of the security scheme (SecuritySchemeType.API_KEY).

ApiKeySecurityScheme

See also

Constructors

Types

Properties