Class OAuth2ACShape

Hierarchy (View Summary)

OAuth2Shape
- OAuth2ACShape

Constructors

constructor

new OAuth2ACShape(
    securitySchemeName: string,
    authorizationRoute: OAuth2ACAuthorizationRoute,
    tokenRoute: OAuth2ACTokenRoute,
    refreshTokenRoute?: OAuth2RefreshTokenRoute<
        ParamsDictionary,
        any,
        any,
        ParsedQs,
        Record<string, any>,
        any,
    >,
): OAuth2ACShape
Parameters
- securitySchemeName: string
- authorizationRoute: OAuth2ACAuthorizationRoute
- tokenRoute: OAuth2ACTokenRoute
- OptionalrefreshTokenRoute: OAuth2RefreshTokenRoute<
      ParamsDictionary,
      any,
      any,
      ParsedQs,
      Record<string, any>,
      any,
  >
Returns OAuth2ACShape
Overrides OAuth2Shape.constructor
- Defined in src/security/oauth2/authorizationCode.ts:209

Properties

`Protected`_authHandlers

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

`Protected`authorizationRoute

authorizationRoute: OAuth2ACAuthorizationRoute

`Protected` `Optional`description

description?: string

`Protected`pkce

pkce: boolean = false

`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

getAuthorizationUrl

getAuthorizationUrl(): string
Returns string
- Defined in src/security/oauth2/authorizationCode.ts:242

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/authorizationCode.ts:246

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/authorizationCode.ts:250

isWithPkce

isWithPkce(): boolean
Returns boolean
- Defined in src/security/oauth2/authorizationCode.ts:231

router

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

scheme

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

setAuthHandlers

setAuthHandlers(
    ...handler: RequestHandler<
        ParamsDictionary,
        any,
        any,
        ParsedQs,
        Record<string, any>,
        any,
    >[],
): this
Parameters
- ...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: string): this
Parameters
- description: string
Returns this
Inherited from OAuth2Shape.setDescription
- Defined in src/security/shapes.ts:28

setRefreshTokenRoute

setRefreshTokenRoute<
    P = ParamsDictionary,
    ResBody = any,
    ReqBody = any,
    ReqQuery = ParsedQs,
    Locals extends Record<string, any> = Record<string, any>,
    MetaResType = any,
>(
    refreshTokenRoute: OAuth2RefreshTokenRoute<
        P,
        ResBody,
        ReqBody,
        ReqQuery,
        Locals,
        MetaResType,
    >,
): 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/authorizationCode.ts:236

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

withoutPkce

withoutPkce(): this
Returns this
- Defined in src/security/oauth2/authorizationCode.ts:226

withPkce

withPkce(): this
Returns this
- Defined in src/security/oauth2/authorizationCode.ts:221

Class OAuth2ACShape

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OAuth2ACShape

Properties

Protected_authHandlers

ProtectedauthorizationRoute

Protected Optionaldescription

Protectedpkce

Protected OptionalrefreshTokenRoute

Protected Optionalscopes

ProtectedsecuritySchemeName

ProtectedtokenRoute

Methods

authHandlers

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

getAuthorizationUrl

Returns string

getDescription

Returns undefined | string

getRefreshTokenUrl

Returns undefined | string

getScopes

Returns undefined | Record<string, string>

getSecuritySchemeName

Returns string

getTokenUrl

Returns string

isWithPkce

Returns boolean

router

Returns IRouter

scheme

Returns BaseAuthUtil

setAuthHandlers

Parameters

Returns this

setDescription

Parameters

Returns this

setRefreshTokenRoute

Type Parameters

Parameters

Returns this

setScopes

Parameters

Returns this

withoutPkce

Returns this

withPkce

Returns this

Settings

On This Page

`Protected`_authHandlers

`Protected`authorizationRoute

`Protected` `Optional`description

`Protected`pkce

`Protected` `Optional`refreshTokenRoute

`Protected` `Optional`scopes

`Protected`securitySchemeName

`Protected`tokenRoute