Skip to main content

OAuthServerParameters

@webda/oauth

Class: OAuthServerParameters

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

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:104

Access token lifetime (s); defaults to TokenService

clientMetadataCacheTtl​

clientMetadataCacheTtl: number

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

Default​

3600

clientMetadataDocuments​

clientMetadataDocuments: boolean

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

Default​

true

clientMetadataHosts​

clientMetadataHosts: string[]

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

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:92

Default​

5

clients​

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

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

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

codeTtl​

codeTtl: number

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

Default​

60

consentUrl?​

optional consentUrl?: string

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

Consent UI; defaults to the built-in page

deviceCodeTtl​

deviceCodeTtl: number

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

Default​

600

devicePollInterval​

devicePollInterval: number

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

Default​

5

deviceUrl?​

optional deviceUrl?: string

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

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

issuer?​

optional issuer?: string

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

Issuer; defaults to the request origin

loginUrl​

loginUrl: string

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

Application login page, receives ?redirect=

refreshTtl?​

optional refreshTtl?: number

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

Refresh token lifetime (s); defaults to TokenService

registration?​

optional registration?: "open" | "off"

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

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:122

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

Default​

7776000

registrationRateLimit​

registrationRateLimit: number

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

Registrations allowed per client IP in the window

Default​

20

registrationRateWindow​

registrationRateWindow: number

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

Window of the registration rate limit (s)

Default​

3600

registrationRedirectPatterns?​

optional registrationRedirectPatterns?: string[]

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

Globs every redirect URI of a registration must match one of

registrationUnusedTtl​

registrationUnusedTtl: number

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

Lifetime of a registered client never used (s)

Default​

86400

rememberConsent​

rememberConsent: boolean

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

Default​

true

rememberConsentTtl​

rememberConsentTtl: number

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

Default​

7776000

resultUrl?​

optional resultUrl?: string

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

Result UI; defaults to the built-in page

scopesSupported?​

optional scopesSupported?: string[]

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

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:78

Default​

"/oauth"

Methods​

load()​

load(params?): this

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

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