JWT Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/jwt/types.ts:82

Properties

Property	Type	Defined in
getJWKSGET	| undefined | (input) => Promise< | { keys: JsonWebKey[]; } | GeneralErrorResponse>	recipe/jwt/types.ts:83

APIOptions

type APIOptions = object;

Defined in: recipe/jwt/types.ts:51

Properties

Property	Type	Defined in
config	TypeNormalisedInput	recipe/jwt/types.ts:53
isInServerlessEnv	boolean	recipe/jwt/types.ts:55
recipeId	string	recipe/jwt/types.ts:54
recipeImplementation	RecipeInterface	recipe/jwt/types.ts:52
req	BaseRequest	recipe/jwt/types.ts:56
res	BaseResponse	recipe/jwt/types.ts:57

JsonWebKey

type JsonWebKey = object;

Defined in: recipe/jwt/types.ts:20

Properties

Property	Type	Defined in
alg	string	recipe/jwt/types.ts:25
e	string	recipe/jwt/types.ts:24
kid	string	recipe/jwt/types.ts:22
kty	string	recipe/jwt/types.ts:21
n	string	recipe/jwt/types.ts:23
use	string	recipe/jwt/types.ts:26

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/jwt/types.ts:60

Methods

createJWT()

createJWT(input): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;

Defined in: recipe/jwt/types.ts:61

Parameters

Parameter	Type
input	{ payload?: any; userContext: UserContext; useStaticSigningKey?: boolean; validitySeconds?: number; }
input.payload?	any
input.userContext	UserContext
input.useStaticSigningKey?	boolean
input.validitySeconds?	number

Returns

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

getJWKS()

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

Defined in: recipe/jwt/types.ts:76

Parameters

Parameter	Type
input	{ userContext: UserContext; }
input.userContext	UserContext

Returns

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

TypeInput

type TypeInput = object;

Defined in: recipe/jwt/types.ts:29

Properties

Property	Type	Defined in
jwtValiditySeconds?	number	recipe/jwt/types.ts:30
override?	object	recipe/jwt/types.ts:31
override.apis?	(originalImplementation, builder) => APIInterface	recipe/jwt/types.ts:36
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/jwt/types.ts:32

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/jwt/types.ts:40

Properties

Property	Type	Defined in
jwtValiditySeconds	number	recipe/jwt/types.ts:41
override	object	recipe/jwt/types.ts:42
override.apis	(originalImplementation, builder) => APIInterface	recipe/jwt/types.ts:47
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/jwt/types.ts:43