Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Type

Applies To

Description

type

string

Any

REQUIRED. The type of the security scheme. Valid values are are "apiKey" or  , "http" , or "oauth2".

description

string

Any

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

name

string

apiKey

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

in

string

apiKey

REQUIRED. The location of the API key. Valid values are "query""header" or "cookie".

scheme

string

http

REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry.

x-ibmi

boolean

http

Set this property to true if this security scheme is for IBMi user/password credentials.

...