Skip to main content

If you are using our backend SDK that is lesser than the following versions, please visit the older documentation link here.

Setting up the Dashboard

Architecture#

Flowchart of architecture when using SuperTokens managed service

The Backend SDK serves the user management dashboard which can be accessed on the /auth/dashboard path of your API domain.

Initialise the dashboard recipe#

To get started, initialise the Dashboard recipe in the recipeList.

import SuperTokens from "supertokens-node";
import Dashboard from "supertokens-node/recipe/dashboard";

SuperTokens.init({
appInfo: {
apiDomain: "...",
appName: "...",
websiteDomain: "...",
},
recipeList: [
// TODO: Initialise other recipes
Dashboard.init(),
],
});

Viewing the dashboard#

important

The user management dashboard is served by the backend SDK, you have to use your API domain when trying to visit the dashboard.

Navigate to <YOUR_API_DOMAIN>/auth/dashboard to view the dashboard.

note

If you are using Next.js, upon integrating our backend SDK into your Next.js API folder, the dashboard will be accessible by default at <YOUR_API_DOMAIN>/api/auth/dashboard. For frameworks other than Next.js, it can be accessed at <YOUR_API_DOMAIN>/auth/dashboard. Should you have customized the apiBasePath configuration property, simply navigate to <YOUR_API_DOMAIN>/auth/dashboard to access the dashboard.

Dashboard login screen UI

Creating dashboard credentials#

Paid Feature

You can create 3 dashboard users* for free.

If you need to create additional users:

  • For self hosted users, please sign up to generate a license key and follow the instructions sent to you by email.
  • For managed service users, you can click on the "enable paid features" button on our dashboard, and follow the steps from there on.

*: A dashboard user is a user that can log into and view the user management dashboard. These users are independent to the users of your application

When you first setup SuperTokens, there are no credentials created for the dashboard. If you click the "Add a new user" button in the dashboard login screen you can see the command you need to execute in order to create credentials.

Dashboard signup screen UI

To create credentials you need to make a request to SuperTokens core.

  • The example above uses the demo core https://try.supertokens.com, replace this with the connection uri you pass to the backend SDK when initialising SuperTokens.
  • Replace <YOUR-API-KEY> with your API key. If you are using a self hosted SuperTokens core there is no API key by default. In that case you can either skip or ignore the api-key header.
  • Replace <YOUR_EMAIL> and <YOUR_PASSWORD> with the appropriate values.
caution

If using self hosted SuperTokens core, you need to make sure that you add an API key to the core in case it's exposed to the internet. Otherwise anyone will be able to create or modify dashboard users.

You can add an API key to the core by following the instructions "Auth flow customizations" > "SuperTokens core settings" > "Adding API keys" page.

Updating dashboard credentials#

You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page.

Reset your password screen UI

To update credentials you need to make a request to SuperTokens core.

  • The example above uses the demo core https://try.supertokens.com, replace this with the connection uri you pass to the backend SDK when initialising SuperTokens.
  • Replace <YOUR-API-KEY> with your API key. If you are using a self hosted SuperTokens core there is no API key by default. In that case you can either skip or ignore the api-key header.
  • Replace <YOUR_EMAIL> and <YOUR_NEW_PASSWORD> with the appropriate values. You can use newEmail instead of newPassword if you want to update the email

Restricting access to dashboard users#

When using the dashboard recipe you can restrict access to certain features by providing a list of emails to be considered as "admins". When a dashboard user logs in with an email not present in this list, they will only be able to perform read operations and all write operations will result in the backend SDKs failing the request.

You can provide an array of emails to the backend SDK when initialising the dashboard recipe:

important
  • Not providing an admins array will result in all dashboard users being allowed both read and write operations
  • Providing an empty array as admins will result in all dashboard users having ONLY read access
import SuperTokens from "supertokens-node";
import Dashboard from "supertokens-node/recipe/dashboard";

SuperTokens.init({
appInfo: {
apiDomain: "...",
appName: "...",
websiteDomain: "...",
},
recipeList: [
// TODO: Initialise other recipes
Dashboard.init({
admins: [
"[email protected]",
],
}),
],
});

Content Security Policy#

If your backend returns a Content-Security-Policy header, you will encounter the following UI displaying the CSP violation details. Follow the instructions provided in this UI to make necessary adjustments to your backend CSP configuration.

CSP error handled UI

For example, to address the error message displayed in the above screenshot, you need to modify your original policy. In the given example, it appears as follows:

script-src:
'self'
'unsafe-inline'
https://google.com

img-src:
https://google.com

To resolve this issue, make the following adjustments:

script-src:
'self'
'unsafe-inline'
https://google.com

img-src:
https://google.com
https://cdn.jsdelivr.net/gh/supertokens/

Essentially, you need to include the domain listed as the Blocked URI in your violated directive block within your original policy.