Class OAuth2ShapeAbstract

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_authHandlers description? scopes? securitySchemeName

Methods

authHandlers getDescription getScopes getSecuritySchemeName router scheme setAuthHandlers setDescription setScopes

Constructors

constructor

Properties

Protected_authHandlers

_authHandlers: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[] = []

Protected Optionaldescription

description?: string

Protected Optionalscopes

scopes?: Record<string, string>

ProtectedsecuritySchemeName

securitySchemeName: string

Methods

authHandlers

  • authHandlers(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]

  • Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]

getDescription

getScopes

  • getScopes(): undefined | Record<string, string>

  • Returns undefined | Record<string, string>

getSecuritySchemeName

Abstractrouter

Abstractscheme

setAuthHandlers

  • setAuthHandlers(...handler): this

  • Parameters

    • Rest...handler: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]

    Returns this

setDescription

setScopes

  • setScopes(scopes): this

  • Parameters

    • scopes: Record<string, string>

      The scopes of the access request. A map between the scope name and a short description for it. The map MAY be empty.

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods