Skip to main content

Abstract Class: BaseOAuthDiscoveryRoute

Defined in: auth/src/routes/BaseOAuthDiscoveryRoute.ts:45

Serves this authorization server's discovery metadata (RFC 8414 "OAuth 2.0 Authorization Server Metadata" and OIDC Discovery §3, which define the same JSON document shape) at whatever path(s) a subclass mounts it to — typically both /.well-known/oauth-authorization-server and /.well-known/openid-configuration, which a single mounted instance of this route can serve simultaneously via @Route([...two paths...]) on the leaf subclass, since the metadata document itself doesn't differ between the two specs for this deployment's purposes.

Has no datastore dependency at all (unlike every other Base*Route in this library) — it only reads config and the endpoints a subclass supplies — so there is deliberately no SQL/Mongo split for this route.

Constructors​

Constructor​

new BaseOAuthDiscoveryRoute(): BaseOAuthDiscoveryRoute

Returns​

BaseOAuthDiscoveryRoute

Properties​

endpoints​

abstract protected endpoints: OAuthDiscoveryEndpoints

Defined in: auth/src/routes/BaseOAuthDiscoveryRoute.ts:53

issuer?​

protected optional issuer?: string

Defined in: auth/src/routes/BaseOAuthDiscoveryRoute.ts:56

supportedScopes​

protected supportedScopes: string[]

Defined in: auth/src/routes/BaseOAuthDiscoveryRoute.ts:59

Methods​

discovery()​

discovery(res): Promise<any>

Defined in: auth/src/routes/BaseOAuthDiscoveryRoute.ts:88

Returns this authorization server's discovery metadata document.

Parameters​

res​

HttpResponse

Returns​

Promise<any>