OpenID Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/openid/types.ts:47

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:48

APIOptions

type APIOptions = object;

Defined in: recipe/openid/types.ts:39

Properties

Property	Type	Defined in
config	TypeNormalisedInput	recipe/openid/types.ts:41
recipeId	string	recipe/openid/types.ts:42
recipeImplementation	RecipeInterface	recipe/openid/types.ts:40
req	BaseRequest	recipe/openid/types.ts:43
res	BaseResponse	recipe/openid/types.ts:44

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/openid/types.ts:69

Methods

createJWT()

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

Defined in: recipe/openid/types.ts:84

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:70

Parameters

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

Returns

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:19

Properties

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

TypeNormalisedInput

type TypeNormalisedInput = object;

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

Properties

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