Skip to main content

OIDCClientParameters

@webda/oidc

Class: OIDCClientParameters

Defined in: packages/oidc/src/client.service.ts:13

Parameters of the OIDC client

Extends​

  • ServiceParameters

Constructors​

Constructor​

new OIDCClientParameters(): OIDCClientParameters

Returns​

OIDCClientParameters

Inherited from​

ServiceParameters.constructor

Properties​

issuerService​

issuerService: string

Defined in: packages/oidc/src/client.service.ts:35

For "self": name of the OIDCIssuer service

Default​

"OIDCIssuer"

refreshMargin​

refreshMargin: number

Defined in: packages/oidc/src/client.service.ts:41

Refresh margin in seconds before the token expiration

Default​

60

requestTimeout​

requestTimeout: number

Defined in: packages/oidc/src/client.service.ts:47

Timeout of the token requests in milliseconds

Default​

5000

source​

source: "self" | "file" | "gcp-metadata" | "github-actions"

Defined in: packages/oidc/src/client.service.ts:23

Token source

  • self: minted by this application OIDCIssuer
  • file: read from tokenFile, like a Kubernetes projected service account token
  • gcp-metadata: identity token of the GCP default service account
  • github-actions: GitHub Actions OIDC token

Default​

"self"

tokenFile?​

optional tokenFile?: string

Defined in: packages/oidc/src/client.service.ts:29

For "file": path of the projected token

Example​

/var/run/secrets/tokens/webda

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/client.service.ts:54

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