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

## Type Aliases

### APIFunction()

```ts check=false reason="Generated API signature"
type APIFunction = (apiImplementation, tenantId, options, userContext) => Promise<any>;
```

Defined in: [recipe/dashboard/types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L68)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `apiImplementation` | [`APIInterface`](#apiinterface) |
| `tenantId` | `string` |
| `options` | [`APIOptions`](#apioptions) |
| `userContext` | [`UserContext`](types#usercontext) |

#### Returns

`Promise`\<`any`\>

***

### APIInterface

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

Defined in: [recipe/dashboard/types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L64)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="dashboardget"></a> `dashboardGET` | `undefined` \| (`input`) => `Promise`\<`string`\> | [recipe/dashboard/types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L65) |

***

### APIOptions

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

Defined in: [recipe/dashboard/types.ts:54](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L54)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="appinfo"></a> `appInfo` | [`NormalisedAppinfo`](types#normalisedappinfo) | [recipe/dashboard/types.ts:61](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L61) |
| <a id="config"></a> `config` | [`TypeNormalisedInput`](#typenormalisedinput) | [recipe/dashboard/types.ts:56](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L56) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv` | `boolean` | [recipe/dashboard/types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L60) |
| <a id="recipeid"></a> `recipeId` | `string` | [recipe/dashboard/types.ts:57](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L57) |
| <a id="recipeimplementation"></a> `recipeImplementation` | [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L55) |
| <a id="req"></a> `req` | `BaseRequest` | [recipe/dashboard/types.ts:58](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L58) |
| <a id="res"></a> `res` | `BaseResponse` | [recipe/dashboard/types.ts:59](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L59) |

***

### AuthMode

```ts check=false reason="Generated API signature"
type AuthMode = "api-key" | "email-password";
```

Defined in: [recipe/dashboard/types.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L77)

***

### CoreConfigFieldInfo

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

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

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultvalue"></a> `defaultValue` | `string` \| `number` \| `boolean` \| `null` | [recipe/dashboard/types.ts:92](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L92) |
| <a id="description"></a> `description` | `string` | [recipe/dashboard/types.ts:88](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L88) |
| <a id="isdifferentacrosstenants"></a> `isDifferentAcrossTenants` | `boolean` | [recipe/dashboard/types.ts:89](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L89) |
| <a id="isnullable"></a> `isNullable` | `boolean` | [recipe/dashboard/types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L91) |
| <a id="ispluginproperty"></a> `isPluginProperty` | `boolean` | [recipe/dashboard/types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L93) |
| <a id="ispluginpropertyeditable"></a> `isPluginPropertyEditable` | `boolean` | [recipe/dashboard/types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L94) |
| <a id="key"></a> `key` | `string` | [recipe/dashboard/types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L85) |
| <a id="possiblevalues"></a> `possibleValues?` | `string`[] | [recipe/dashboard/types.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L90) |
| <a id="value"></a> `value` | `string` \| `number` \| `boolean` \| `null` | [recipe/dashboard/types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L87) |
| <a id="valuetype"></a> `valueType` | `"string"` \| `"boolean"` \| `"number"` | [recipe/dashboard/types.ts:86](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L86) |

***

### RecipeIdForUser

```ts check=false reason="Generated API signature"
type RecipeIdForUser = "emailpassword" | "thirdparty" | "passwordless" | "webauthn";
```

Defined in: [recipe/dashboard/types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L75)

***

### RecipeInterface

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

Defined in: [recipe/dashboard/types.ts:45](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L45)

#### Methods

##### getDashboardBundleLocation()

```ts check=false reason="Generated API signature"
getDashboardBundleLocation(input): Promise<string>;
```

Defined in: [recipe/dashboard/types.ts:46](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L46)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `userContext`: [`UserContext`](types#usercontext); \} |
| `input.userContext` | [`UserContext`](types#usercontext) |

###### Returns

`Promise`\<`string`\>

##### shouldAllowAccess()

```ts check=false reason="Generated API signature"
shouldAllowAccess(input): Promise<boolean>;
```

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `config`: [`TypeNormalisedInput`](#typenormalisedinput); `req`: `BaseRequest`; `userContext`: [`UserContext`](types#usercontext); \} |
| `input.config` | [`TypeNormalisedInput`](#typenormalisedinput) |
| `input.req` | `BaseRequest` |
| `input.userContext` | [`UserContext`](types#usercontext) |

###### Returns

`Promise`\<`boolean`\>

***

### TypeInput

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

Defined in: [recipe/dashboard/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L20)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="admins"></a> `admins?` | `string`[] | [recipe/dashboard/types.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L22) |
| <a id="apikey"></a> `apiKey?` | `string` | [recipe/dashboard/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L21) |
| <a id="override"></a> `override?` | `object` | [recipe/dashboard/types.ts:23](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L23) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/dashboard/types.ts:28](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L28) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L24) |

***

### TypeNormalisedInput

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

Defined in: [recipe/dashboard/types.ts:32](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L32)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="admins-1"></a> `admins?` | `string`[] | [recipe/dashboard/types.ts:34](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L34) |
| <a id="apikey-1"></a> `apiKey?` | `string` | [recipe/dashboard/types.ts:33](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L33) |
| <a id="authmode-1"></a> `authMode` | [`AuthMode`](#authmode) | [recipe/dashboard/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L35) |
| <a id="override-1"></a> `override` | `object` | [recipe/dashboard/types.ts:36](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L36) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/dashboard/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L41) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/dashboard/types.ts:37](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L37) |

***

### UserWithFirstAndLastName

```ts check=false reason="Generated API signature"
type UserWithFirstAndLastName = User & object;
```

Defined in: [recipe/dashboard/types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L79)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `firstName?` | `string` | [recipe/dashboard/types.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L80) |
| `lastName?` | `string` | [recipe/dashboard/types.ts:81](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/dashboard/types.ts#L81) |