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

## Classes

### default

Defined in: [recipe/openid/index.ts:4](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L4)

#### Constructors

##### Constructor

```ts check=false reason="Generated API signature"
new default(): default;
```

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="member-default-init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types#recipelistfunction) | `OpenIdRecipe.init` | [recipe/openid/index.ts:5](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L5) |

#### Methods

##### getOpenIdDiscoveryConfiguration()

```ts check=false reason="Generated API signature"
static getOpenIdDiscoveryConfiguration(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;
}>;
```

Defined in: [recipe/openid/index.ts:7](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L7)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

###### 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`;
\}\>

## Variables

### getOpenIdDiscoveryConfiguration()

```ts check=false reason="Generated API signature"
getOpenIdDiscoveryConfiguration: (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;
}> = OpenIdRecipeWrapper.getOpenIdDiscoveryConfiguration;
```

Defined in: [recipe/openid/index.ts:15](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L15)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext?` | `Record`\<`string`, `any`\> |

#### 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`;
\}\>

***

### init()

```ts check=false reason="Generated API signature"
init: (config?) => RecipeListFunction = OpenIdRecipeWrapper.init;
```

Defined in: [recipe/openid/index.ts:14](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/openid/index.ts#L14)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-openid-types#typeinput) |

#### Returns

[`RecipeListFunction`](types#recipelistfunction)