Skip to content

Commit 270c028

Browse files
committed
Rewrite tenant settings reference; standardize api and application settings references; update dashboard index page
1 parent 120c9d3 commit 270c028

File tree

16 files changed

+2916
-161
lines changed

16 files changed

+2916
-161
lines changed

articles/api-auth/tutorials/password-grant.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ You should use this flow **only if** the following apply:
2121

2222
## Before you start
2323

24-
* Check that your application's [grant type property](/applications/concepts/application-grant-types) is set appropriately
25-
* [Register the API](/apis#how-to-configure-an-api-in-auth0) with Auth0
26-
* Check that the [Default Audience and/or Default Directory](/dashboard/dashboard-tenant-settings#api-authorization-settings) has been set appropriately
24+
* Check that your application's [grant type property](/applications/concepts/application-grant-types) is set appropriately.
25+
* [Register the API](/apis#how-to-configure-an-api-in-auth0) with Auth0.
26+
* Check that the [Default Audience and/or Default Directory](dashboard/reference/settings-tenant#api-authorization-settings) has been set appropriately.
2727
* Update or disable any [rules](/rules), such as rules that deny access based on an email domain whitelist, so they only impact specific connections. If you get an `'access_denied'` error when testing the Password Grant, this could be due to an access control rule.
2828

2929
## Configure your tenant

articles/architecture-scenarios/_includes/_branding/_introduction.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ If you are sharing an Auth0 tenant across multiple customer organizations, provi
2727
While Auth0 provides for default information when it comes to error situations, out-of-the-box information can be somewhat cryptic as the context that can only be provided by you is missing. Auth0 [error page customization](/architecture-scenarios/implementation/${platform}/${platform}-branding#error-page-customization) guidance can however help mitigate that by allowing you to provide information of a more context-specific nature via your own support organization.
2828

2929
::: panel Best Practice
30-
To provide users with helpful resources if they experience problems you should also configure a friendly name and a suitable logo, as well as the support email and support URL for your organization. See [Dashboard Tenant Settings](/dashboard/dashboard-tenant-settings#settings) for further details.
30+
To provide helpful resources for users who experience problems, you should also configure a friendly name and a logo, as well as provide the support email address and URL for your organization. To learn how, see [Dashboard Tenant Settings](/dashboard/reference/settings-tenant#settings).
3131
:::
3232

3333
::: panel Get Started with Auth0 Videos
34-
Watch these three short videos [Brand: How It Works](/videos/get-started/07_01-brand-how-it-works), [Brand: Signup and Login Pages](/videos/get-started/07_02-brand-signup-login-pages), and [Brand: Emails and Error Pages](/videos/get-started/08-brand-emails-error-pages) to learn how branding works with Auth0, how to use Auth0’s Universal Login feature to customize your sign up and login pages, and how to use Auth0 email templates and make changes to the reply email address, subject, redirect URL, and URL lifetime.
34+
Watch three short videos—[Brand: How It Works](/videos/get-started/07_01-brand-how-it-works), [Brand: Signup and Login Pages](/videos/get-started/07_02-brand-signup-login-pages), and [Brand: Emails and Error Pages](/videos/get-started/08-brand-emails-error-pages)—to learn how branding works with Auth0, how to use Auth0’s Universal Login feature to customize your sign up and login pages, and how to use Auth0 email templates and make changes to the reply email address, subject, redirect URL, and URL lifetime.
3535
:::

articles/architecture-scenarios/_includes/_logout/_introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If the user logs out and you redirect them back to the application, and the appl
3232

3333
## Automatic termination of sessions
3434

35-
Not all users will trigger the logout process manually, so Auth0 also provides **session timeout** to prevent overly long-lived sessions. This setting is [available and configurable via the Auth0 Dashboard](/dashboard/dashboard-tenant-settings#session-timeout).
35+
Not all users will trigger the logout process manually, so Auth0 also provides **session timeout** to prevent overly long-lived sessions. This setting is [available and configurable via the Auth0 Dashboard](/dashboard/reference/settings-tenant#login-session-management).
3636

3737
<% if (platform === "b2b") { %>
3838
[Federated User Logout](/logout/guides/logout-idps) may be something that you need to consider for your application. If you or your customers will be using a third-party IdP (i.e., something other than a [Database Identity Provider](/connections/database)) then the question of whether you need to log the user out of the IdP when they log out of your application is something you will need to answer. The answer depends on what your users would expect. If the applicaiton and/or IdP you use is tied closely to a customer organization and a central part of day-to-day operations, then it may be frustrating for users to get logged out of their IdP when they log out of your application. If not, then being logged out of the IdP may be expected, or in some cases even desired. In most B2B scenarios, our customers find that it is preferable *not* to perform federated logout for a user.

articles/best-practices/tenant-settings.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ For <dfn data-key="security-assertion-markup-language">SAML</dfn> connections th
4242

4343
## Set Single Sign-on session timeout
4444

45-
The <dfn data-key="single-sign-on">Single Sign-on (SSO)</dfn> [session timeout value](/dashboard/dashboard-tenant-settings#session-timeout) in your tenant settings specifies the time until a user's session expires. By default the value is 7 days. During this time, users can access your Auth0-integrated applications without re-entering their credentials.
45+
The <dfn data-key="single-sign-on">Single Sign-on (SSO)</dfn> [session timeout value](/dashboard/reference/settings-tenant#login-session-management) in your tenant settings specifies the time until a user's session expires. By default the value is 7 days. During this time, users can access your Auth0-integrated applications without re-entering their credentials.
4646

4747
Adjust this value to fit your application’s desired user experience and security requirements.
4848

4949
For example, enterprise environments may choose 8 hours or shorter to ensure users authenticate at least once per shift. But for customer-facing environments, where long sessions are desirable for the user experience, the value might be set to much longer than 7 days.
5050

5151
## Periodically review dashboard admins
5252

53-
On a regular basis, review the list of [dashboard administrators](/dashboard/dashboard-tenant-settings#dashboard-admins) with access to your Auth0 tenant and make sure that:
53+
On a regular basis, review the list of [dashboard administrators](/dashboard/reference/settings-tenant#dashboard-admins) with access to your Auth0 tenant and make sure that:
5454

5555
- each person has a legitimate need for admin access
5656
- admins are registered with a company account

articles/configure/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ contentType: index
1111
Learn how to configure tenants, applications, APIs, and other settings in Auth0.
1212

1313
<%= include('../_includes/_topic-links', { links: [
14-
'dashboard/dashboard-tenant-settings',
14+
'dashboard/reference/settings-tenant',
1515
'dashboard/reference/settings-application',
1616
'dashboard/reference/settings-api',
1717
'sso/current',

articles/dashboard/dashboard-tenant-settings.md

-132
This file was deleted.

articles/dashboard/index.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,28 @@ useCase: manage-accounts
2020

2121
<ul class="topic-links">
2222
<li>
23-
<i class="icon icon-budicon-715"></i><a href="/users/guides/create-users">Create Users using the Dashboard</a>
24-
<p>How to create end users using the Dashboard</p>
23+
<i class="icon icon-budicon-715"></i><a href="/users/guides/create-users">Create Users</a>
24+
<p>Learn how to create users.</p>
2525
</li>
2626
<li>
2727
<i class="icon icon-budicon-715"></i><a href="/dashboard/manage-dashboard-admins">Manage Dashboard Administrators</a>
28-
<p>How to add and manage user accounts with admin privileges to the Dashboard</p>
28+
<p>Learn how to add and manage user accounts with admin privileges.</p>
2929
</li>
3030
<li>
31-
<i class="icon icon-budicon-715"></i><a href="/dashboard/dashboard-tenant-settings">Configure your Dashboard Tenant Settings</a>
32-
<p>How to change the settings for a given tenant using the Dashboard</p>
31+
<i class="icon icon-budicon-715"></i><a href="/logs">Manage Logs</a>
32+
<p>Learn how to view log data and understand log event types.</p>
3333
</li>
34-
<li>
35-
<i class="icon icon-budicon-715"></i><a href="/logs">Logs</a>
36-
<p>How to view log data and understand log event types</p>
34+
<li>
35+
<i class="icon icon-budicon-715"></i><a href="/dashboard/reference/settings-tenant">Tenant Settings</a>
36+
<p>Explore the settings available for tenants.</p>
37+
</li>
38+
<li>
39+
<i class="icon icon-budicon-715"></i><a href="/dashboard/reference/settings-application">Application Settings</a>
40+
<p>Explore the settings available for applications.</p>
41+
</li>
42+
<li>
43+
<i class="icon icon-budicon-715"></i><a href="/dashboard/reference/settings-api">API Settings</a>
44+
<p>Explore the settings available for APIs.</p>
3745
</li>
3846
</ul>
47+

articles/dashboard/reference/settings-api.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Auth0 Dashboard API Settings
3-
description: Learn about the API Settings available through the Auth0 Dashboard.
2+
title: API Settings
3+
description: Learn about the settings related to APIs available in the Auth0 Dashboard.
44
topics:
55
- api-authentication
66
- oidc
@@ -11,10 +11,9 @@ useCase:
1111
- secure-api
1212
- call-api
1313
---
14-
1514
# API Settings
1615

17-
In the [API](${manage_url}/#/apis) section, locate your API and click on its *Settings* to review the available settings:
16+
On the [APIs](${manage_url}/#/apis) page of the [Auth0 Dashboard](${manage_url}/), locate your API and click its name to view the available settings.
1817

1918
- **Id**: A unique alphanumeric string generated by Auth0. This information is read-only, and you will only need it if you will be working directly with [Auth0's Management API Resource Servers endpoints](/api/management/v2#!/Resource_Servers/get_resource_servers_by_id).
2019

articles/dashboard/reference/settings-application.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Auth0 Dashboard Application Settings
3-
description: Learn about the Application Settings available through the Auth0 Dashboard.
2+
title: Application Settings
3+
description: Learn about the settings related to applications available in the Auth0 Dashboard.
44
topics:
55
- api-authentication
66
- oidc
@@ -10,10 +10,9 @@ contentType: reference
1010
useCase:
1111
- add-login
1212
---
13-
1413
# Application Settings
1514

16-
In the [Application](${manage_url}/#/applications) section, locate your Application, and click on its *Settings* to review the available settings.
15+
On the [Applications](${manage_url}/#/applications) page of the [Auth0 Dashboard](${manage_url}/, locate your Application and click its name to view the available settings.
1716

1817
## Basic Settings
1918

0 commit comments

Comments
 (0)