Skip to main content

OIDCIssuerParameters

@webda/oidc

Class: OIDCIssuerParameters

Defined in: packages/oidc/src/issuer.service.ts:57

Parameters of the OIDC issuer

Extends​

  • ServiceParameters

Constructors​

Constructor​

new OIDCIssuerParameters(): OIDCIssuerParameters

Returns​

OIDCIssuerParameters

Inherited from​

ServiceParameters.constructor

Properties​

algorithm​

algorithm: OIDCSigningAlgorithm

Defined in: packages/oidc/src/issuer.service.ts:82

Signing algorithm, asymmetric only

ES256 requires the CryptoService to generate EC P-256 keys (asymetricType: "ec")

Default​

"RS256"

audiences​

audiences: string[]

Defined in: packages/oidc/src/issuer.service.ts:89

Allowed audiences patterns (glob), minting for another audience is refused

A lone * allows any audience, otherwise * does not cross /: https://*.example.com

Default​

["*"]

issuer​

issuer: string

Defined in: packages/oidc/src/issuer.service.ts:63

Public issuer URL, MUST be https in production, no trailing slash

Example​

https://orders.example.com

name​

name: string

Defined in: packages/oidc/src/issuer.service.ts:69

Application name, put in sub as app:<name> and in claim webda_app

Default​

application package name

tokenTtl​

tokenTtl: number

Defined in: packages/oidc/src/issuer.service.ts:75

Token lifetime in seconds

Default​

300

type​

type: string

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

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/oidc/src/issuer.service.ts:96

Parameters​

params?​

any = {}

the input 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