supertokens-node/recipe/jwt

References documentation for the supertokens-node/recipe/jwt package

Classes

default

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
`init`	`static`	(`config?`) => `RecipeListFunction`	`Recipe.init`	recipe/jwt/index.ts

Methods

createJWT()

static createJWT(
   payload, 
   validitySeconds?, 
   useStaticSigningKey?, 
   userContext?): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;

Defined in: recipe/jwt/index.ts

Parameters

Parameter	Type
`payload`	`any`
`validitySeconds?`	`number`
`useStaticSigningKey?`	`boolean`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { jwt: string; status: "OK"; } | { status: "UNSUPPORTED_ALGORITHM_ERROR"; }>

getJWKS()

static getJWKS(userContext?): Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}>;

Defined in: recipe/jwt/index.ts

Parameters

Parameter	Type
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ keys: JsonWebKey[]; validityInSeconds?: number; }>

Variables

createJWT()

createJWT: (payload, validitySeconds?, useStaticSigningKey?, userContext?) => Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}> = Wrapper.createJWT;

Defined in: recipe/jwt/index.ts

Parameters

Parameter	Type
`payload`	`any`
`validitySeconds?`	`number`
`useStaticSigningKey?`	`boolean`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { jwt: string; status: "OK"; } | { status: "UNSUPPORTED_ALGORITHM_ERROR"; }>

getJWKS()

getJWKS: (userContext?) => Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}> = Wrapper.getJWKS;

Defined in: recipe/jwt/index.ts

Parameters

Parameter	Type
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ keys: JsonWebKey[]; validityInSeconds?: number; }>

init()

init: (config?) => RecipeListFunction = Wrapper.init;

Defined in: recipe/jwt/index.ts

Parameters

Parameter	Type
`config?`	`TypeInput`

Returns

RecipeListFunction

References

APIInterface

Re-exports APIInterface

APIOptions

Re-exports APIOptions

JsonWebKey

Re-exports JsonWebKey

RecipeInterface

Re-exports RecipeInterface