Class ContextAuthUtil

Helps defining scopes for security requirements of a route.

[[include:auth/oAuth2Util.md]]

Hierarchy

BaseContextAuthUtil
- ContextAuthUtil

Index

Constructors

Properties

authUtil contextScopes

Methods

toOpenAPISecurity toPostman

Constructors

constructor

new ContextAuthUtil(authUtil, scopes?): ContextAuthUtil
Parameters
- authUtil: BaseAuthUtil
- Optionalscopes: string[]
Returns ContextAuthUtil
Overrides BaseContextAuthUtil.constructor
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/contextAuthUtils.d.ts:13

Properties

`Protected`authUtil

authUtil: BaseAuthUtil

`Protected`contextScopes

contextScopes: string[]

Methods

toOpenAPISecurity

toOpenAPISecurity(): SecurityRequirementObject[]
Returns SecurityRequirementObject[]
Overrides BaseContextAuthUtil.toOpenAPISecurity
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/contextAuthUtils.d.ts:15

toPostman

toPostman(): Auth
Returns Auth
Overrides BaseContextAuthUtil.toPostman
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/contextAuthUtils.d.ts:14