Class HttpScheme

HTTP authentication scheme

Hierarchy (View Summary)

AuthScheme
- HttpScheme

Index

Constructors

Properties

bearerFormat? description? scheme type

Constructors

constructor

new HttpScheme(
    config: {
        bearerFormat?: string;
        description?: string;
        scheme: "basic" | "bearer" | "digest" | "other";
    },
): HttpScheme
Constructor for HttpScheme
Parameters
- config: {
      bearerFormat?: string;
      description?: string;
      scheme: "basic" | "bearer" | "digest" | "other";
  }
Returns HttpScheme
Overrides AuthScheme.constructor
- Defined in models/auth/AuthScheme.ts:81

Properties

`Optional`bearerFormat

bearerFormat?: string

Bearer format when scheme is 'bearer'

`Optional`description

description?: string

Description of the scheme

scheme

scheme: "basic" | "bearer" | "digest" | "other"

The HTTP authentication scheme

type

type: AuthSchemeType

The type of authentication scheme