Jwt | virgil-sdk

Class representing the JWT providing access to the Virgil Security APIs. Implements IAccessToken interface.

Hierarchy

Jwt

Implements

IAccessToken

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Jwt(stringRepresentation: string): Jwt
new Jwt(header: IJwtHeader, body: IJwtBody, signature?: undefined | string): Jwt

- Defined in Auth/Jwt.ts:101
Creates a new instance of Jwt from the given string. The string must be in the following format: base64UrlEncode(header).base64UrlEncode(body).base64UrlEncode(signature)

Parameters
- stringRepresentation: string
Returns Jwt
- Defined in Auth/Jwt.ts:109
Creates a new instance of Jwt with the given header, body and optional signature.

Parameters
- header: IJwtHeader
- body: IJwtBody
- Optional signature: undefined | string
Returns Jwt

Properties

body

header

header: IJwtHeader

Optional signature

signature: undefined | string

unsignedData

unsignedData: string

The data used to calculate the JWT Signature

base64UrlEncode(header) + "." + base64UrlEncode(body)

Methods

appId

appId(): string

- Defined in Auth/Jwt.ts:178
Retrieves the application ID that is the issuer of this JWT.

Returns string

identity

identity(): string

Implementation of IAccessToken.identity
- Defined in Auth/Jwt.ts:166
Retrieves the identity that is the subject of this JWT.

Returns string

isExpired

isExpired(at?: Date): boolean

- Defined in Auth/Jwt.ts:193
Returns a boolean indicating whether this JWT is (or will be) expired at the given date or not.

Parameters
- Default value at: Date = new Date
  
  The date to check. Defaults to new Date().
Returns boolean
- true if token is expired, otherwise false.

toString

toString(): string

Implementation of IAccessToken.toString
- Defined in Auth/Jwt.ts:158
Returns the string representation of this JWT.

Returns string

Static fromString

fromString(jwtStr: string): Jwt

- Defined in Auth/Jwt.ts:87
Parses the string representation of the JWT into an object representation.

Parameters
- jwtStr: string
  
  The JWT string. Must have the following format:
  
  base64UrlEncode(Header) + "." + base64UrlEncode(Body) + "." + base64UrlEncode(Signature)
  
  See the Introduction to JWT for more details.
Returns Jwt