You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With the user management dashboard, you can view the list of users on SuperTokens and be able to easily view, modify or delete their sessions, metadata, roles and account info.
22
-
23
-
To get started, initialise the Dashboard recipe in the `recipeList` on the backend and provide a random and unique API key that is known only to you. This API key will later be used to access the dashboard from the UI.
21
+
To get started, initialise the Dashboard recipe in the `recipeList`.
You can create one dashboard user* for free. If you need to create additional users please email us at [email protected].
104
+
105
+
*: 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
106
+
:::
107
+
108
+
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.
To create credentials you need to make a request to SuperTokens core.
113
+
114
+
- 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.
115
+
- 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.
116
+
- Replace `<YOUR_EMAIL>` and `<YOUR_PASSWORD>` with the appropriate values
117
+
118
+
## Updating dashboard credentials
119
+
120
+
You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page.
To update credentials you need to make a request to SuperTokens core.
125
+
126
+
- 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.
127
+
- 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.
128
+
- 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
94
129
95
-
<imgsrc="/img/dashboard/api-key.png"alt="Enter API screen of dashboard" />
130
+
## Viewing users
96
131
97
-
You should enter the same API as the one you provided in the `dashboard.init` function call. On successful authentication, you will see the following UI
132
+
If you have just created your app, you may not have any users to show on the dashboard.
Now, navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
136
+
Navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
102
137
103
138
<imgsrc="/img/dashboard/one-user.png"alt="One user in dashboard" />
With the user management dashboard, you can view the list of users on SuperTokens and be able to easily view, modify or delete their sessions, metadata, roles and account info.
22
-
23
-
To get started, initialise the Dashboard recipe in the `recipeList` on the backend and provide a random and unique API key that is known only to you. This API key will later be used to access the dashboard from the UI.
21
+
To get started, initialise the Dashboard recipe in the `recipeList`.
You can create one dashboard user* for free. If you need to create additional users please email us at [email protected].
104
+
105
+
*: 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
106
+
:::
107
+
108
+
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.
To create credentials you need to make a request to SuperTokens core.
113
+
114
+
- 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.
115
+
- 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.
116
+
- Replace `<YOUR_EMAIL>` and `<YOUR_PASSWORD>` with the appropriate values
117
+
118
+
## Updating dashboard credentials
119
+
120
+
You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page.
To update credentials you need to make a request to SuperTokens core.
125
+
126
+
- 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.
127
+
- 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.
128
+
- 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
94
129
95
-
<imgsrc="/img/dashboard/api-key.png"alt="Enter API screen of dashboard" />
130
+
## Viewing users
96
131
97
-
You should enter the same API as the one you provided in the `dashboard.init` function call. On successful authentication, you will see the following UI
132
+
If you have just created your app, you may not have any users to show on the dashboard.
Now, navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
136
+
Navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
102
137
103
138
<imgsrc="/img/dashboard/one-user.png"alt="One user in dashboard" />
With the user management dashboard, you can view the list of users on SuperTokens and be able to easily view, modify or delete their sessions, metadata, roles and account info.
22
-
23
-
To get started, initialise the Dashboard recipe in the `recipeList` on the backend and provide a random and unique API key that is known only to you. This API key will later be used to access the dashboard from the UI.
21
+
To get started, initialise the Dashboard recipe in the `recipeList`.
You can create one dashboard user* for free. If you need to create additional users please email us at [email protected].
104
+
105
+
*: 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
106
+
:::
107
+
108
+
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.
To create credentials you need to make a request to SuperTokens core.
113
+
114
+
- 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.
115
+
- 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.
116
+
- Replace `<YOUR_EMAIL>` and `<YOUR_PASSWORD>` with the appropriate values
117
+
118
+
## Updating dashboard credentials
119
+
120
+
You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page.
To update credentials you need to make a request to SuperTokens core.
125
+
126
+
- 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.
127
+
- 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.
128
+
- 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
94
129
95
-
<imgsrc="/img/dashboard/api-key.png"alt="Enter API screen of dashboard" />
130
+
## Viewing users
96
131
97
-
You should enter the same API as the one you provided in the `dashboard.init` function call. On successful authentication, you will see the following UI
132
+
If you have just created your app, you may not have any users to show on the dashboard.
Now, navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
136
+
Navigate to the your frontend app and create a user (via the sign up flow). On creation, if you head back to the dashboard and refresh the page, you will see that user:
102
137
103
138
<imgsrc="/img/dashboard/one-user.png"alt="One user in dashboard" />
0 commit comments