Skip to main content

IssueOptions

@webda/core


Interface: IssueOptions

Defined in: packages/core/src/services/token.service.ts:54

Options of TokenService.issue

Properties​

accessTtl?​

optional accessTtl?: number

Defined in: packages/core/src/services/token.service.ts:82

Access token lifetime (s), defaults to the accessTtl parameter; kept by the family on refresh


audience?​

optional audience?: string

Defined in: packages/core/src/services/token.service.ts:73

Audience of this access token when it is not resource: one of resources. The family keeps resource as its default audience


clientId?​

optional clientId?: string

Defined in: packages/core/src/services/token.service.ts:56

OAuth client


createdAt?​

optional createdAt?: number

Defined in: packages/core/src/services/token.service.ts:89

Internal

Creation of the family (ms), carried across rotations; defaults to now set by TokenService.refresh


issuer?​

optional issuer?: string

Defined in: packages/core/src/services/token.service.ts:78

Authorization server issuing the tokens: becomes their iss, with the RFC 9068 at+jwt type, so another application can verify them from the issuer keys. Not stored: give it again on refresh


lastUsedAt?​

optional lastUsedAt?: number

Defined in: packages/core/src/services/token.service.ts:94

Internal

Last refresh of the family (ms) set by TokenService.refresh


name?​

optional name?: string

Defined in: packages/core/src/services/token.service.ts:80

Display name of the refresh family


refreshToken?​

optional refreshToken?: string

Defined in: packages/core/src/services/token.service.ts:99

Internal

The raw refresh token to store, instead of a new random one set by TokenService.refresh, which records its hash on the rotated token before issuing it


refreshTtl?​

optional refreshTtl?: number

Defined in: packages/core/src/services/token.service.ts:84

Refresh token lifetime (s), defaults to the refreshTtl parameter; kept by the family on refresh


resource?​

optional resource?: string

Defined in: packages/core/src/services/token.service.ts:63

Resource (RFC 8707) the access tokens are bound to: becomes their audience unless audience chooses another; kept by the family on refresh


resources?​

optional resources?: string[]

Defined in: packages/core/src/services/token.service.ts:68

Other resources (RFC 8707 §2.2) the family may mint access tokens for: a refresh naming one of them gets a token with that audience, from the same family; kept by the family on refresh


scope?​

optional scope?: Scope

Defined in: packages/core/src/services/token.service.ts:58

Granted scope