Class JwtClaims

JWT claims that were part of the bearer token with this request.

Hierarchy

JwtClaims

Index

Properties

metadata

Constructors

constructor

Accessors

Methods

Properties

Readonly metadata

metadata: Metadata

The metadata backing this JWT claims object.

Constructors

constructor

new JwtClaims(metadata: Metadata): JwtClaims

- Defined in src/jwt-claims.ts:37
This exposes JWT claims that were extracted from the bearer token.

Parameters
- metadata: Metadata
  
  The metadata that the JWT claims come from
Returns JwtClaims

Accessors

issuer

get issuer(): undefined | string

- Defined in src/jwt-claims.ts:47
Get the issuer, that is, the iss claim, as described in RFC 7519 section 4.1.1.

see
RFC 7519 section 4.1.1

Returns undefined | string
the issuer, if present.

subject

get subject(): undefined | string

- Defined in src/jwt-claims.ts:57
Get the subject, that is, the sub claim, as described in RFC 7519 section 4.1.2.

see
RFC 7519 section 4.1.2

Returns undefined | string
the subject, if present.

audience

get audience(): undefined | string

- Defined in src/jwt-claims.ts:67
Get the audience, that is, the aud claim, as described in RFC 7519 section 4.1.3.

see
RFC 7519 section 4.1.3

Returns undefined | string
the audience, if present.

expirationTime

get expirationTime(): undefined | Date

- Defined in src/jwt-claims.ts:77
Get the expiration time, that is, the exp claim, as described in RFC 7519 section 4.1.4.

see
RFC 7519 section 4.1.4

Returns undefined | Date
the expiration time, if present.

notBefore

get notBefore(): undefined | Date

- Defined in src/jwt-claims.ts:87
Get the not before, that is, the nbf claim, as described in RFC 7519 section 4.1.5.

see
RFC 7519 section 4.1.5

Returns undefined | Date
the not before, if present.

issuedAt

get issuedAt(): undefined | Date

- Defined in src/jwt-claims.ts:97
Get the issued at, that is, the iat claim, as described in RFC 7519 section 4.1.6.

see
RFC 7519 section 4.1.6

Returns undefined | Date
the issued at, if present.

jwtId

get jwtId(): undefined | string

- Defined in src/jwt-claims.ts:107
Get the JWT ID, that is, the jti claim, as described in RFC 7519 section 4.1.7.

see
RFC 7519 section 4.1.7

Returns undefined | string
the JWT ID, if present.

Methods

getString

getString(name: string): undefined | string

- Defined in src/jwt-claims.ts:116
Get the string claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | string

getNumber

getNumber(name: string): undefined | number

- Defined in src/jwt-claims.ts:129
Get the number claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | number

getNumericDate

getNumericDate(name: string): undefined | Date

- Defined in src/jwt-claims.ts:148
Get the numeric date claim with the given name.

Numeric dates are expressed as a number of seconds since epoch, as described in RFC 7519 section 2.

see
RFC 7519 section 2

Parameters
- name: string
  
  The name of the claim
Returns undefined | Date

getBoolean

getBoolean(name: string): undefined | boolean

- Defined in src/jwt-claims.ts:161
Get the boolean claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | boolean

getObject

getObject(name: string): any

- Defined in src/jwt-claims.ts:177
Get the object claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns any

getStringArray

getStringArray(name: string): undefined | string[]

- Defined in src/jwt-claims.ts:197
Get the string array claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | string[]

getNumberArray

getNumberArray(name: string): undefined | number[]

- Defined in src/jwt-claims.ts:206
Get the number array claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | number[]

getBooleanArray

getBooleanArray(name: string): undefined | boolean[]

- Defined in src/jwt-claims.ts:215
Get the boolean array claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | boolean[]

getObjectArray

getObjectArray(name: string): undefined | any[]

- Defined in src/jwt-claims.ts:224
Get the object array claim with the given name.

Parameters
- name: string
  
  The name of the claim
Returns undefined | any[]

getNumericDateArray

getNumericDateArray(name: string): undefined | Date[]

- Defined in src/jwt-claims.ts:236
Get the numeric date array claim with the given name.

Numeric dates are expressed as a number of seconds since epoch, as described in RFC 7519 section 2.

see
RFC 7519 section 2

Parameters
- name: string
  
  The name of the claim
Returns undefined | Date[]

Generated using TypeDoc