Class HttpScheme

HTTP authentication scheme

Hierarchy (view full)

AuthScheme
- HttpScheme

Index

Constructors

Properties

type scheme bearerFormat? description?

Constructors

constructor

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

Properties

type

type: AuthSchemeType

The type of authentication scheme

scheme

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

The HTTP authentication scheme

`Optional`bearerFormat

bearerFormat?: string

Bearer format when scheme is 'bearer'

`Optional`description

description?: string

Description of the scheme