Class OAuth2PasswordShape

Hierarchy (view full)

OAuth2Shape
- OAuth2PasswordShape

Constructors

constructor

new OAuth2PasswordShape(securitySchemeName, tokenRoute, refreshTokenRoute?): OAuth2PasswordShape
Parameters
- securitySchemeName: string
- tokenRoute: OAuth2PasswordTokenRoute<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>
- OptionalrefreshTokenRoute: OAuth2RefreshTokenRoute<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>
Returns OAuth2PasswordShape
Overrides OAuth2Shape.constructor
- Defined in src/security/oauth2/password.ts:96

Properties

`Protected`_authHandlers

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

`Protected`clientAuthentication

clientAuthentication: ClientAuthentication = ClientAuthentication.body

`Protected` `Optional`description

description?: string

`Protected` `Optional`refreshTokenRoute

refreshTokenRoute?: IOAuth2Route

`Protected` `Optional`scopes

scopes?: Record<string, string>

`Protected`securitySchemeName

securitySchemeName: string

`Protected`tokenRoute

tokenRoute: IOAuth2Route

Methods

authHandlers

authHandlers(): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]
Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]
Inherited from OAuth2Shape.authHandlers
- Defined in src/security/shapes.ts:61

clientAuthenticationToBody

clientAuthenticationToBody(): this
Returns this
- Defined in src/security/oauth2/password.ts:139

clientAuthenticationToHeader

clientAuthenticationToHeader(): this
Returns this
- Defined in src/security/oauth2/password.ts:147

getDescription

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

getRefreshTokenUrl

getRefreshTokenUrl(): undefined | string
Returns undefined | string
- Defined in src/security/oauth2/password.ts:162

getScopes

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

getSecuritySchemeName

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

getTokenUrl

getTokenUrl(): string
Returns string
- Defined in src/security/oauth2/password.ts:166

isClientAuthenticationToBody

isClientAuthenticationToBody(): boolean
Returns boolean
- Defined in src/security/oauth2/password.ts:143

isClientAuthenticationToHeader

isClientAuthenticationToHeader(): boolean
Returns boolean
- Defined in src/security/oauth2/password.ts:151

router

router(): IRouter
Returns IRouter
Overrides OAuth2Shape.router
- Defined in src/security/oauth2/password.ts:170

scheme

scheme(): BaseAuthUtil
Returns BaseAuthUtil
Overrides OAuth2Shape.scheme
- Defined in src/security/oauth2/password.ts:350

setAuthHandlers

setAuthHandlers(...handler): this
Parameters
- Rest...handler: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>, any>[]
Returns this
Inherited from OAuth2Shape.setAuthHandlers
- Defined in src/security/shapes.ts:44

setDescription

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

setRefreshTokenRoute

setRefreshTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>(refreshTokenRoute): this
Type Parameters
- P = ParamsDictionary
- ResBody = any
- ReqBody = any
- ReqQuery = ParsedQs
- Locals extends Record<string, any> = Record<string, any>
- MetaResType = any
Parameters
- refreshTokenRoute: OAuth2RefreshTokenRoute<P, ResBody, ReqBody, ReqQuery, Locals, MetaResType>
Returns this
- Defined in src/security/oauth2/password.ts:156

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
Inherited from OAuth2Shape.setScopes
- Defined in src/security/shapes.ts:39