Class OAuth2Shape`Abstract`

Hierarchy (View Summary)

OAuth2Shape

Implements

ISecurityShape

Index

Constructors

Properties

_authHandlers description? scopes? securitySchemeName

Methods

authHandlers getDescription getScopes getSecuritySchemeName router scheme setAuthHandlers setDescription setScopes

Constructors

constructor

new OAuth2Shape(securitySchemeName: string): OAuth2Shape
Parameters
- securitySchemeName: string
Returns OAuth2Shape
- Defined in src/security/shapes.ts:22

Properties

`Protected`_authHandlers

_authHandlers: RequestHandler[] = []

`Protected` `Optional`description

description?: string

`Protected` `Optional`scopes

scopes?: Record<string, string>

`Protected`securitySchemeName

securitySchemeName: string

Methods

authHandlers

authHandlers(): RequestHandler[]
Returns RequestHandler[]
Implementation of ISecurityShape.authHandlers
- Defined in src/security/shapes.ts:61

getDescription

getDescription(): undefined | string
Returns undefined | string
- Defined in src/security/shapes.ts:57

getScopes

getScopes(): undefined | Record<string, string>
Returns undefined | Record<string, string>
- Defined in src/security/shapes.ts:49

getSecuritySchemeName

getSecuritySchemeName(): string
Returns string
- Defined in src/security/shapes.ts:53

`Abstract`router

router(): IRouter
Returns IRouter
Implementation of ISecurityShape.router
- Defined in src/security/shapes.ts:65

`Abstract`scheme

scheme(): BaseAuthUtil
Returns BaseAuthUtil
Implementation of ISecurityShape.scheme
- Defined in src/security/shapes.ts:67

setAuthHandlers

setAuthHandlers(...handler: RequestHandler[]): this
Parameters
- ...handler: RequestHandler[]
Returns this
- Defined in src/security/shapes.ts:44

setDescription

setDescription(description: string): this
Parameters
- description: string
Returns this
- Defined in src/security/shapes.ts:28

setScopes

setScopes(scopes: Record<string, string>): 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
- Defined in src/security/shapes.ts:39