JwtGenerator | virgil-sdk

Class responsible for JWT generation.

Hierarchy

JwtGenerator

Index

Constructors

constructor

Properties

Methods

generateToken

Constructors

constructor

new JwtGenerator(options: IJwtGeneratorOptions): JwtGenerator

- Defined in Auth/JwtGenerator.ts:79
Parameters
- options: IJwtGeneratorOptions
Returns JwtGenerator

Properties

accessTokenSigner

accessTokenSigner: IAccessTokenSigner

see: IJwtGeneratorOptions.accessTokenSigner

apiKey

apiKey: IPrivateKey

see: IJwtGeneratorOptions.apiKey

apiKeyId

apiKeyId: string

see: IJwtGeneratorOptions.apiKeyId

appId

appId: string

see: IJwtGeneratorOptions.appId

millisecondsToLive

millisecondsToLive: number

see: IJwtGeneratorOptions.millisecondsToLive

Methods

generateToken

generateToken(identity: string, ada?: IExtraData): Jwt

- Defined in Auth/JwtGenerator.ts:101
Generates a token with the given identity as the subject and optional additional data.

Parameters
- identity: string
  
  Identity to be associated with JWT (i.e. the Subject).
- Optional ada: IExtraData
  
  Additional data to be encoded in the JWT.
Returns Jwt