diff --git a/v2/emailpassword/custom-ui/init/dashboard.mdx b/v2/emailpassword/custom-ui/init/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/emailpassword/custom-ui/init/dashboard.mdx +++ b/v2/emailpassword/custom-ui/init/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/emailpassword/pre-built-ui/setup/dashboard.mdx b/v2/emailpassword/pre-built-ui/setup/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/emailpassword/pre-built-ui/setup/dashboard.mdx +++ b/v2/emailpassword/pre-built-ui/setup/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/passwordless/custom-ui/init/dashboard.mdx b/v2/passwordless/custom-ui/init/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/passwordless/custom-ui/init/dashboard.mdx +++ b/v2/passwordless/custom-ui/init/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/passwordless/pre-built-ui/setup/dashboard.mdx b/v2/passwordless/pre-built-ui/setup/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/passwordless/pre-built-ui/setup/dashboard.mdx +++ b/v2/passwordless/pre-built-ui/setup/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/static/img/dashboard/api-key.png b/v2/static/img/dashboard/api-key.png deleted file mode 100644 index dea4908b9..000000000 Binary files a/v2/static/img/dashboard/api-key.png and /dev/null differ diff --git a/v2/static/img/dashboard/forgot-password.png b/v2/static/img/dashboard/forgot-password.png new file mode 100644 index 000000000..e9413cca8 Binary files /dev/null and b/v2/static/img/dashboard/forgot-password.png differ diff --git a/v2/static/img/dashboard/login.png b/v2/static/img/dashboard/login.png new file mode 100644 index 000000000..dc263e30d Binary files /dev/null and b/v2/static/img/dashboard/login.png differ diff --git a/v2/static/img/dashboard/signup.png b/v2/static/img/dashboard/signup.png new file mode 100644 index 000000000..51c434721 Binary files /dev/null and b/v2/static/img/dashboard/signup.png differ diff --git a/v2/thirdparty/custom-ui/init/dashboard.mdx b/v2/thirdparty/custom-ui/init/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdparty/custom-ui/init/dashboard.mdx +++ b/v2/thirdparty/custom-ui/init/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/thirdparty/pre-built-ui/setup/dashboard.mdx b/v2/thirdparty/pre-built-ui/setup/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdparty/pre-built-ui/setup/dashboard.mdx +++ b/v2/thirdparty/pre-built-ui/setup/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/thirdpartyemailpassword/custom-ui/init/dashboard.mdx b/v2/thirdpartyemailpassword/custom-ui/init/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdpartyemailpassword/custom-ui/init/dashboard.mdx +++ b/v2/thirdpartyemailpassword/custom-ui/init/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/thirdpartyemailpassword/pre-built-ui/setup/dashboard.mdx b/v2/thirdpartyemailpassword/pre-built-ui/setup/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdpartyemailpassword/pre-built-ui/setup/dashboard.mdx +++ b/v2/thirdpartyemailpassword/pre-built-ui/setup/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/thirdpartypasswordless/custom-ui/init/dashboard.mdx b/v2/thirdpartypasswordless/custom-ui/init/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdpartypasswordless/custom-ui/init/dashboard.mdx +++ b/v2/thirdpartypasswordless/custom-ui/init/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/thirdpartypasswordless/pre-built-ui/setup/dashboard.mdx b/v2/thirdpartypasswordless/pre-built-ui/setup/dashboard.mdx index 6450bcba7..09bda230b 100644 --- a/v2/thirdpartypasswordless/pre-built-ui/setup/dashboard.mdx +++ b/v2/thirdpartypasswordless/pre-built-ui/setup/dashboard.mdx @@ -14,13 +14,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -36,10 +34,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -58,10 +55,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -80,8 +76,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -90,15 +87,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard diff --git a/v2/userdashboard/about.mdx b/v2/userdashboard/about.mdx index 9e78e2e9b..3faa5106b 100644 --- a/v2/userdashboard/about.mdx +++ b/v2/userdashboard/about.mdx @@ -6,6 +6,8 @@ hide_title: true # How to use the user management 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. + ## Complete quick setup Before you can use the user management dashboard make sure to complete setting up SuperTokens on your backend by following the quick setup guide for the recipe of your choice, view all recipes [here](/docs/guides) @@ -18,13 +20,11 @@ import BackendSDKTabs from "/src/components/tabs/BackendSDKTabs"; import TabItem from '@theme/TabItem'; import AppInfoForm from "/src/components/appInfoForm" -## Setting up and viewing the user management dashboard +## Initialise the dashboard recipe -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. - -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. +To get started, initialise the Dashboard recipe in the `recipeList`. @@ -40,10 +40,9 @@ SuperTokens.init({ websiteDomain: "...", }, recipeList: [ + // TODO: Initialise other recipes // highlight-start - Dashboard.init({ - apiKey: "" - }), + Dashboard.init(), // highlight-end ], }); @@ -62,10 +61,9 @@ import ( func main() { supertokens.Init(supertokens.TypeInput{ RecipeList: []supertokens.Recipe{ + // TODO: Initialise other recipes // highlight-start - dashboard.Init(dashboardmodels.TypeInput{ - ApiKey: "", - }), + dashboard.Init(nil), // highlight-end }, }) @@ -84,8 +82,9 @@ init( api_domain="...", app_name="...", website_domain="..."), framework='...', # type: ignore recipe_list=[ + # TODO: Initialise other recipes # highlight-start - dashboard.init(api_key=""), + dashboard.init(), # highlight-end ] ) @@ -94,15 +93,53 @@ init( -Now, if you navigate to `^{form_apiDomain}^{form_apiBasePath}/dashboard`, you will now be able to see the enter API screen. +## 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 `^{form_apiDomain}^{form_apiBasePath}/dashboard` to view the dashboard. + +Dashboard login screen + +## Creating dashboard credentials + +:::tip Paid Feature +You can create one dashboard user* for free. If you need to create additional users please email us at team@supertokens.com. + +*: 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 login screen + +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 `` 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 `` and `` with the appropriate values + +## Updating dashboard credentials + +You can update the email or password of existing credentials by using the "Forgot Password" button on the dashboard login page. + +Dashboard login screen + +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 `` 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 `` and `` with the appropriate values. You can use `newEmail` instead of `newPassword` if you want to update the email -Enter API screen of dashboard +## Viewing users -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 +If you have just created your app, you may not have any users to show on the dashboard. Empty 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: +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: One user in dashboard