supertokens-node/recipe/openid/types

References documentation for the supertokens-node/recipe/openid/types package

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/openid/types.ts

Properties

Property	Type	Defined in
`getOpenIdDiscoveryConfigurationGET`	\| `undefined` \| (`input`) => `Promise`< \| { `authorization_endpoint`: `string`; `end_session_endpoint`: `string`; `id_token_signing_alg_values_supported`: `string`[]; `issuer`: `string`; `jwks_uri`: `string`; `response_types_supported`: `string`[]; `revocation_endpoint`: `string`; `status`: `"OK"`; `subject_types_supported`: `string`[]; `token_endpoint`: `string`; `token_introspection_endpoint`: `string`; `userinfo_endpoint`: `string`; } \| `GeneralErrorResponse`>	recipe/openid/types.ts

APIOptions

type APIOptions = object;

Defined in: recipe/openid/types.ts

Properties

Property	Type	Defined in
`config`	`TypeNormalisedInput`	recipe/openid/types.ts
`recipeId`	`string`	recipe/openid/types.ts
`recipeImplementation`	`RecipeInterface`	recipe/openid/types.ts
`req`	`BaseRequest`	recipe/openid/types.ts
`res`	`BaseResponse`	recipe/openid/types.ts

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/openid/types.ts

Methods

createJWT()

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

Defined in: recipe/openid/types.ts

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"; }>

getOpenIdDiscoveryConfiguration()

getOpenIdDiscoveryConfiguration(input): Promise<{
  authorization_endpoint: string;
  end_session_endpoint: string;
  id_token_signing_alg_values_supported: string[];
  issuer: string;
  jwks_uri: string;
  response_types_supported: string[];
  revocation_endpoint: string;
  status: "OK";
  subject_types_supported: string[];
  token_endpoint: string;
  token_introspection_endpoint: string;
  userinfo_endpoint: string;
}>;

Defined in: recipe/openid/types.ts

Parameters

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

Promise<{ authorization_endpoint: string; end_session_endpoint: string; id_token_signing_alg_values_supported: string[]; issuer: string; jwks_uri: string; response_types_supported: string[]; revocation_endpoint: string; status: "OK"; subject_types_supported: string[]; token_endpoint: string; token_introspection_endpoint: string; userinfo_endpoint: string; }>

TypeInput

type TypeInput = object;

Defined in: recipe/openid/types.ts

Properties

Property	Type	Defined in
`override?`	`object`	recipe/openid/types.ts
`override.apis?`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/openid/types.ts
`override.functions?`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/openid/types.ts

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/openid/types.ts

Properties

Property	Type	Defined in
`override`	`object`	recipe/openid/types.ts
`override.apis`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/openid/types.ts
`override.functions`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/openid/types.ts