---
title: supertokens-node/recipe/openid/types
description: References documentation for the supertokens-node/recipe/openid/types package
sidebar:
  order: 260
---

## Type Aliases

### APIInterface

```ts check=false reason="Generated API signature"
type APIInterface = object;
```

Defined in: [recipe/openid/types.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L47)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="getopeniddiscoveryconfigurationget"></a> `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`](types#generalerrorresponse)\> | [recipe/openid/types.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L48) |

***

### APIOptions

```ts check=false reason="Generated API signature"
type APIOptions = object;
```

Defined in: [recipe/openid/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L39)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/openid/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L41) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/openid/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L42) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:40](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L40) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/openid/types.ts:43](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L43) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/openid/types.ts:44](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L44) |

***

### RecipeInterface

```ts check=false reason="Generated API signature"
type RecipeInterface = object;
```

Defined in: [recipe/openid/types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L69)

#### Methods

##### createJWT()

```ts check=false reason="Generated API signature"
createJWT(input): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;
```

Defined in: [recipe/openid/types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L84)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `payload?`: `any`; `userContext`: [`UserContext`](types#usercontext); `useStaticSigningKey?`: `boolean`; `validitySeconds?`: `number`; \} |
| `input.payload?` | `any` |
| `input.userContext` | [`UserContext`](types#usercontext) |
| `input.useStaticSigningKey?` | `boolean` |
| `input.validitySeconds?` | `number` |

###### Returns

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

##### getOpenIdDiscoveryConfiguration()

```ts check=false reason="Generated API signature"
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](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L70)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: [`UserContext`](types#usercontext); \} |
| `input.userContext` | [`UserContext`](types#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

```ts check=false reason="Generated API signature"
type TypeInput = object;
```

Defined in: [recipe/openid/types.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L19)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/openid/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L20) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/openid/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L25) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L21) |

***

### TypeNormalisedInput

```ts check=false reason="Generated API signature"
type TypeNormalisedInput = object;
```

Defined in: [recipe/openid/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/openid/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L30) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/openid/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L35) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/openid/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/types.ts#L31) |