OS3SecurityHTTP

@tsed/openspec

Usage

import { OS3SecurityHTTP } from "@tsed/openspec";

See /packages/specs/openspec/src/types/openspec3/OS3Security.ts.

Overview

interface OS3SecurityHTTP extends OS3SecurityBase {
    type: "http";
    scheme: string;
    bearerFormat?: string;
}

type

type: "http";

The type of the security scheme

scheme

scheme: string;

The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.

bearerFormat

bearerFormat?: string;

A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.