Class ApiKeyScheme

API Key authentication scheme

Hierarchy (View Summary)

AuthScheme
- ApiKeyScheme

Index

Constructors

Properties

description? in name type

Constructors

constructor

new ApiKeyScheme(
    config: {
        description?: string;
        in: "query" | "header" | "cookie";
        name: string;
    },
): ApiKeyScheme
Constructor for ApiKeyScheme
Parameters
- config: { description?: string; in: "query" | "header" | "cookie"; name: string }
Returns ApiKeyScheme
Overrides AuthScheme.constructor
- Defined in models/auth/AuthScheme.ts:47

Properties

`Optional`description

description?: string

Description of the API key

in

in: "query" | "header" | "cookie"

Where the API key is sent

name

name: string

Name of the parameter

type

type: AuthSchemeType

The type of authentication scheme