Skip to main content

QOAuthServerRoute

@quik/oauth-server

@quik/oauth-server / QOAuthServerRoute

Class: QOAuthServerRoute

Defined in: oauth-server/src/QOAuthServerRoute.ts:19

API route exposing OAuth server endpoints.

Extends​

  • QRoute

Constructors​

Constructor​

new QOAuthServerRoute(): QOAuthServerRoute

Defined in: oauth-server/src/QOAuthServerRoute.ts:23

Returns​

QOAuthServerRoute

Overrides​

QRoute.constructor

Properties​

_basePath​

protected _basePath: string = "/"

Defined in: http/src/router/QRoute.ts:21

Inherited from​

QRoute._basePath

_condition​

protected _condition: () => boolean

Defined in: http/src/router/QRoute.ts:9

Returns​

boolean

Inherited from​

QRoute._condition

_endpoints​

protected _endpoints: IQEndpointDefinition[] = []

Defined in: http/src/router/QRoute.ts:27

Inherited from​

QRoute._endpoints

_engineMiddlewares​

protected _engineMiddlewares: unknown[] = []

Defined in: http/src/router/QRoute.ts:39

Inherited from​

QRoute._engineMiddlewares

_flags​

protected _flags: string[] = []

Defined in: http/src/router/QRoute.ts:15

Inherited from​

QRoute._flags

_middlewares​

protected _middlewares: QEndpointMiddleware[] = []

Defined in: http/src/router/QRoute.ts:33

Inherited from​

QRoute._middlewares

oauthServerService​

protected readonly oauthServerService: QOAuthServerService

Defined in: oauth-server/src/QOAuthServerRoute.ts:21

OAuth server service used by route handlers.

Accessors​

basePath​

Get Signature​

get basePath(): string

Defined in: http/src/router/QRoute.ts:23

Returns​

string

Inherited from​

QRoute.basePath

condition​

Get Signature​

get condition(): () => boolean

Defined in: http/src/router/QRoute.ts:11

Returns​

() => boolean

Inherited from​

QRoute.condition

endpoints​

Get Signature​

get endpoints(): IQEndpointDefinition[]

Defined in: http/src/router/QRoute.ts:29

Returns​

IQEndpointDefinition[]

Inherited from​

QRoute.endpoints

engineMiddlewares​

Get Signature​

get engineMiddlewares(): unknown[]

Defined in: http/src/router/QRoute.ts:41

Returns​

unknown[]

Inherited from​

QRoute.engineMiddlewares

flags​

Get Signature​

get flags(): string[]

Defined in: http/src/router/QRoute.ts:17

Returns​

string[]

Inherited from​

QRoute.flags

logger​

Get Signature​

get protected logger(): IQLogger

Defined in: core/src/QObject.ts:15

The logger getter for the object.

Returns​

IQLogger

Inherited from​

QRoute.logger

middlewares​

Get Signature​

get middlewares(): QEndpointMiddleware[]

Defined in: http/src/router/QRoute.ts:35

Returns​

QEndpointMiddleware[]

Inherited from​

QRoute.middlewares

name​

Get Signature​

get name(): string

Defined in: core/src/QObject.ts:8

Returns​

string

Inherited from​

QRoute.name

Methods​

authorize()​

authorize(event): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthServerRoute.ts:38

Issues an OAuth authorization code.

Parameters​

event​

QBodyOnlyEvent<OAuthAuthorizeRequestBody>

Request event with authorization payload.

Returns​

Promise<IQResponse<any>>

endSpan()​

protected endSpan(span): void

Defined in: core/src/QObject.ts:35

End a span returned by startSpan.

Parameters​

span​

TelemetrySpan

The span to end.

Returns​

void

Inherited from​

QRoute.endSpan

introspect()​

introspect(event): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthServerRoute.ts:128

Introspects an OAuth token.

Parameters​

event​

QBodyOnlyEvent<OAuthIntrospectRequestBody>

Request event with introspection payload.

Returns​

Promise<IQResponse<any>>

jwks()​

jwks(): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthServerRoute.ts:164

Returns JSON Web Key Set metadata used to validate access tokens.

Returns​

Promise<IQResponse<any>>

normalizeScope()​

protected normalizeScope(scope?): string[]

Defined in: oauth-server/src/QOAuthServerRoute.ts:173

Normalizes scope values into an array of scope identifiers.

Parameters​

scope?​

string

Raw scope value from the request.

Returns​

string[]

recordSpanError()​

protected recordSpanError(span, err): void

Defined in: core/src/QObject.ts:45

Record an exception on an active span.

Parameters​

span​

TelemetrySpan

The span to record the error on.

err​

unknown

The error to record.

Returns​

void

Inherited from​

QRoute.recordSpanError

revoke()​

revoke(event): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthServerRoute.ts:148

Revokes an OAuth token.

Parameters​

event​

QBodyOnlyEvent<OAuthRevokeRequestBody>

Request event with revoke payload.

Returns​

Promise<IQResponse<any>>

setSpanAttribute()​

protected setSpanAttribute(span, key, value): void

Defined in: core/src/QObject.ts:64

Set a single attribute on an active span.

Parameters​

span​

TelemetrySpan

The span to update.

key​

string

Attribute key.

value​

string | number | boolean

Attribute value.

Returns​

void

Inherited from​

QRoute.setSpanAttribute

startSpan()​

protected startSpan(spanName, options?): TelemetrySpan

Defined in: core/src/QObject.ts:26

Start a telemetry span for the given operation name. Returns undefined when no telemetry provider is active.

Parameters​

spanName​

string

Name of the span.

options?​

TelemetrySpanOptions

Optional span attributes and kind.

Returns​

TelemetrySpan

Inherited from​

QRoute.startSpan

token()​

token(event): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthServerRoute.ts:65

Exchanges OAuth grants for access tokens.

Parameters​

event​

QBodyOnlyEvent<OAuthTokenRequestBody>

Request event with token payload.

Returns​

Promise<IQResponse<any>>

toObject()​

toObject(): Record<string, any>

Defined in: http/src/router/QRoute.ts:48

Return a plain object representation of the route.

Returns​

Record<string, any>

Inherited from​

QRoute.toObject