QOAuthClientManagementRoute

@quik/oauth-server

---

@quik/oauth-server / QOAuthClientManagementRoute

Class: QOAuthClientManagementRoute

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:16

API route exposing OAuth client management endpoints.

Extends

• QRoute

Constructors

Constructor

new QOAuthClientManagementRoute(): QOAuthClientManagementRoute

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:20

Returns

QOAuthClientManagementRoute

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/QOAuthClientManagementRoute.ts:18

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

createClient()

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

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:35

Creates one OAuth client and returns secret only once when generated.

Parameters

event

QBodyOnlyEvent<OAuthClientCreateRequestBody>

Request event with client payload.

Returns

Promise<IQResponse<any>>

---

deleteClient()

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

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:98

Deletes one OAuth client by id.

Parameters

event

QPathParametersOnlyEvent<OAuthClientPathParameters>

Request event with path parameters.

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

---

getClient()

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

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:64

Returns one OAuth client by id without secret.

Parameters

event

QPathParametersOnlyEvent<OAuthClientPathParameters>

Request event with path parameters.

Returns

Promise<IQResponse<any>>

---

listClients()

listClients(): Promise<IQResponse<any>>

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:49

Returns all OAuth clients without secrets.

Returns

Promise<IQResponse<any>>

---

mapCreateInput()

protected mapCreateInput(body): QOAuthCreateClientInput

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:108

Maps creation body data to service input shape.

Parameters

body

OAuthClientCreateRequestBody

Request body.

Returns

QOAuthCreateClientInput

---

mapPublicClient()

protected mapPublicClient(client): object

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:136

Creates a public client projection that excludes the client secret.

Parameters

client

QOAuthClient

OAuth client entity.

Returns

object

---

mapUpdateInput()

protected mapUpdateInput(body): QOAuthUpdateClientInput

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:123

Maps update body data to service input shape.

Parameters

body

OAuthClientUpdateRequestBody

Request body.

Returns

QOAuthUpdateClientInput

---

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

---

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

---

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

---

updateClient()

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

Defined in: oauth-server/src/QOAuthClientManagementRoute.ts:82

Updates one OAuth client by id.

Parameters

event

QEvent<OAuthClientPathParameters, never, OAuthClientUpdateRequestBody>

Request event with path and body.

Returns

Promise<IQResponse<any>>