Skip to main content

OAuthServerParameters

@webda/oauth

Class: OAuthServerParameters

Defined in: packages/oauth/src/parameters.ts:86

OAuthServer parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new OAuthServerParameters(): OAuthServerParameters

Returns​

OAuthServerParameters

Inherited from​

ServiceParameters.constructor

Properties​

accessTtl?​

optional accessTtl?: number

Defined in: packages/oauth/src/parameters.ts:136

Access token lifetime (s); defaults to TokenService

clientMetadataCacheTtl​

clientMetadataCacheTtl: number

Defined in: packages/oauth/src/parameters.ts:126

Client metadata cache TTL

Default​

3600

clientMetadataDocuments​

clientMetadataDocuments: boolean

Defined in: packages/oauth/src/parameters.ts:110

Whether client metadata documents is enabled

Default​

true

clientMetadataHosts​

clientMetadataHosts: string[]

Defined in: packages/oauth/src/parameters.ts:116

Hosts allowed to serve Client ID Metadata Documents. Empty (default): any public host is accepted. Non-empty: only these hosts are accepted, and they bypass the private address check (so internal hosts can be listed)

clientMetadataTimeout​

clientMetadataTimeout: number

Defined in: packages/oauth/src/parameters.ts:121

Client metadata timeout

Default​

5

clients​

clients: Record<string, Omit<OAuthClient, "id"> | null>

Defined in: packages/oauth/src/parameters.ts:105

Static clients by id; null removes a built-in client

codeTtl​

codeTtl: number

Defined in: packages/oauth/src/parameters.ts:143

Code TTL

Default​

60

consentUrl?​

optional consentUrl?: string

Defined in: packages/oauth/src/parameters.ts:130

Consent UI; defaults to the built-in page

deviceCodeTtl​

deviceCodeTtl: number

Defined in: packages/oauth/src/parameters.ts:148

Device code TTL

Default​

600

devicePollInterval​

devicePollInterval: number

Defined in: packages/oauth/src/parameters.ts:153

Device poll interval

Default​

5

deviceUrl?​

optional deviceUrl?: string

Defined in: packages/oauth/src/parameters.ts:132

Device code entry UI; defaults to the built-in page

issuer?​

optional issuer?: string

Defined in: packages/oauth/src/parameters.ts:96

Issuer; defaults to the request origin. When set, the access tokens carry it as iss with the RFC 9068 at+jwt type, so another application can verify them (see resources)

loginUrl​

loginUrl: string

Defined in: packages/oauth/src/parameters.ts:128

Application login page, receives ?redirect=

refreshTtl?​

optional refreshTtl?: number

Defined in: packages/oauth/src/parameters.ts:138

Refresh token lifetime (s); defaults to TokenService

registration?​

optional registration?: "open" | "off"

Defined in: packages/oauth/src/parameters.ts:171

Dynamic client registration (RFC 7591); defaults to open when a protected resource is registered, else off

registrationIdleTtl​

registrationIdleTtl: number

Defined in: packages/oauth/src/parameters.ts:169

Lifetime of a registered client since its last use (s)

Default​

7776000

registrationRateLimit​

registrationRateLimit: number

Defined in: packages/oauth/src/parameters.ts:176

Registrations allowed per client IP in the window

Default​

20

registrationRateWindow​

registrationRateWindow: number

Defined in: packages/oauth/src/parameters.ts:179

Window of the registration rate limit (s)

Default​

3600

registrationRedirectPatterns?​

optional registrationRedirectPatterns?: string[]

Defined in: packages/oauth/src/parameters.ts:173

Globs every redirect URI of a registration must match one of

registrationUnusedTtl​

registrationUnusedTtl: number

Defined in: packages/oauth/src/parameters.ts:166

Lifetime of a registered client never used (s)

Default​

86400

rememberConsent​

rememberConsent: boolean

Defined in: packages/oauth/src/parameters.ts:158

Whether remember consent is enabled

Default​

true

rememberConsentTtl​

rememberConsentTtl: number

Defined in: packages/oauth/src/parameters.ts:163

Remember consent TTL

Default​

7776000

resources​

resources: string[]

Defined in: packages/oauth/src/parameters.ts:103

Protected resources served by other applications (absolute URIs, RFC 8707): accepted as a resource or a client defaultResource, never chosen by default. Their tokens are verified from the issuer keys, so they require issuer, an asymmetric CryptoService algorithm and its published JWKS (url)

Default​

[]

resultUrl?​

optional resultUrl?: string

Defined in: packages/oauth/src/parameters.ts:134

Result UI; defaults to the built-in page

scopesSupported?​

optional scopesSupported?: string[]

Defined in: packages/oauth/src/parameters.ts:181

Advertised scopes; defaults to the top-level operation groups

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

url​

url: string

Defined in: packages/oauth/src/parameters.ts:91

URL

Default​

"/oauth"

Methods​

load()​

load(params?): this

Defined in: packages/oauth/src/parameters.ts:188

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with