Class SubscriptionToken

constructor

• new SubscriptionToken(provider, payload): SubscriptionToken

• After a token is validated, it's payload is passed to this class, where it is parsed and stored for easy access.

  Parameters

  • provider: Provider

    Provider instance
  • payload: string | JwtPayload

    Decoded JWT payload

  Returns SubscriptionToken

expiresAt

issuedAt

issuer

scriptsClaims

subject

matches

• matches(target): boolean

• To make it easier to check a user's level of access.

  Parameters

  • target: {
        scriptGroupId?: string;
        scriptId: string | string[];
    }

    Matches specific script groups and/or scripts.

    • Optional scriptGroupId?: string

    • scriptId: string | string[]

  Returns boolean

  Example: Checking a user has access to a script

  
  const token = new SubscriptionToken(provider, payload);
  
  const isAllowed = token.matches({
      script_id:'my-script-id',
      script_group_id:'my-script-group-id'
  });
  
  if (!isAllowed) {
          // User does not have access to this script
          // return 403
  }
  
  // User has access to this script
  
  Copy