Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
467 changes: 230 additions & 237 deletions main/config/navigation/get-started.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion main/config/navigation/quickstarts.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"root": "docs/quickstarts",
"pages": [
"docs/quickstarts",
"docs/quickstart/agent-skills",
{
"group": "Single Page App",
Expand Down
48 changes: 48 additions & 0 deletions main/config/redirects.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,44 @@
[
{
"source": "docs/get-started/auth0-overview/create-tenants/child-tenants",
"destination": "docs/get-started/auth0-teams/tenant-management#manage-multiple-tenants/"
},
{
"source": "docs/get-started/auth0-overview/create-tenants/create-multiple-tenants",
"destination": "docs/get-started/auth0-teams/tenant-management#manage-multiple-tenants"
},
{
"source": "docs/get-started/onboarding/self-service-m2m",
"destination": "docs/get-started/auth0-overview/create-applications/machine-to-machine-apps"
},
{
"source": "docs/get-started/auth0-overview",
"destination": "docs/get-started/identity-fundamentals/introduction-to-auth0"
},
{
"source": "docs/get-started/tenant-settings/configure-device-user-code-settings",
"destination": "docs/get-started/tenant-settings#device-flow-user-code-format"
},
{
"source": "docs/get-started/dashboard-profile/light-and-dark-themes",
"destination": "docs/get-started/auth0-overview/dashboard#manage-account-settings"
},
{
"source": "docs/get-started/onboarding",
"destination": "docs/get-started/identity-fundamentals/introduction-to-auth0"
},
{
"source": "docs/get-started/dashboard-profile",
"destination": "docs/get-started/auth0-overview/dashboard"
},
{
"source": "docs/get-started/identity-fundamentals",
"destination": "docs/get-started/identity-fundamentals/identity-and-access-management"
},
{
"source": "docs/customize/login-pages/advanced-customizations/configure",
"destination": "docs/customize/login-pages/advanced-customizations/configure/overview"
},
{
"source": "docs/troubleshoot/customer-support/support-channels",
"destination": "/docs/troubleshoot/customer-support"
Expand Down Expand Up @@ -22302,5 +22342,13 @@
{
"source": "/docs/ja-jp/secure/mdl-verification/*",
"destination": "/docs/ja-jp/secure"
},
{
"source": "/docs/get-started/authentication-and-authorization-flow/token-exchange-flow/call-your-api-using-the-custom-token-exchange-flow",
"destination": "/docs/get-started/authentication-and-authorization-flow/token-exchange-flow"
},
{
"source": "docs/get-started/applications/confidential-and-public-applications/view-application-type",
"destination": "docs/get-started/applications/confidential-and-public-applications"
}
]
22 changes: 21 additions & 1 deletion main/docs/deploy-monitor/deployment-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
description: Describes Auth0 public and private cloud deployment options.
title: Deployment Options
---

Auth0 provides both public cloud and private cloud deployment options and tools to help you with your Enterprise deployment.

The Auth0 identity platform can be deployed in the following ways:
Expand All @@ -12,9 +13,28 @@ The Auth0 identity platform can be deployed in the following ways:
| [**Private Cloud on AWS**](/docs/deploy-monitor/deploy-private-cloud/private-cloud-on-aws) | A dedicated, managed cloud service running on AWS providing isolation, higher performance, dev instances, Geo-HA add-ons and more |
| [**Private Cloud on Azure**](/docs/deploy-monitor/deploy-private-cloud/private-cloud-on-azure) | A dedicated cloud service running on Azure providing isolation, higher performance, dev instances, Geo-HA add-ons and more |

## Public Cloud

When you create a tenant in the public cloud environment, you choose a region. The region determines the locality of your tenant, which control where your data is hosted and forms part of your Auth0 domain.

| Region | Locality |
|---------------------------|-----------|
| Australia | AU |
| Canada | CA |
| Europe | EU |
| Japan | JP |
| United Kingdom | UK |
| United States of America | US |

Each reach has multiple sub-localities: for example, EU and EU-2, or US, US-3, US-4, and US-5. When you choose a region for your tenant, we automatically assign a sub-locality (meaning you can't choose a specific one).

You can view your tenant's sub-locality on [Dashboard > Settings> General](https://manage.auth0.com/#/tenant/general) under **Region**. Your tenant's sub-locality may affect things like feature configuration details where noted in the docs.

## Private Cloud

The **Private Cloud** packages are managed services that you can use if you:

* Cannot use a multi-tenant public cloud service in your organization
* Require a guaranteed level of requests per second (RPS)

If you have specific support requirements or need more information about the Professional Services we offer, please [contact Auth0 Sales](https://auth0.com/contact-us).
If you have specific support requirements or need more information about the Professional Services we offer, please [contact Auth0 Sales](https://auth0.com/contact-us).
10 changes: 4 additions & 6 deletions main/docs/get-started/apis.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: API Basics
description: Explore key topics related to working with APIs.
sidebarTitle: Overview
title: APIs
---
An API is an entity that represents an external resource, capable of accepting and responding to protected resource requests made by applications. In the [OAuth2 specification](https://tools.ietf.org/html/rfc6749), an API maps to the **<Tooltip tip="Resource Server: Server hosting protected resources. Resource servers accept and respond to protected resource requests." cta="View Glossary" href="/docs/glossary?term=Resource+Server">Resource Server</Tooltip>**.

An API is an entity that represents an external resource, capable of accepting and responding to protected resource requests made by applications. In the [OAuth2 specification](https://tools.ietf.org/html/rfc6749), an API maps to the <Tooltip tip="Resource Server: Server hosting protected resources. Resource servers accept and respond to protected resource requests." cta="View Glossary" href="/docs/glossary?term=Resource+Server">Resource Server</Tooltip>.

At some point, your custom APIs will need to allow limited access to their protected resources on behalf of users. Authorization refers to the process of verifying what a user has access to. While often used interchangeably with [authentication](/docs/authenticate), authorization represents a fundamentally different function. To learn more, read [Authentication and Authorization](/docs/get-started/identity-fundamentals/authentication-and-authorization).

Expand All @@ -22,9 +22,7 @@ Since only the API can know all of the possible actions that it can handle, it s
To protect an API, you must register an API using the <Tooltip tip="Auth0 Dashboard: Auth0's main product to configure your services." cta="View Glossary" href="/docs/glossary?term=Auth0+Dashboard">Auth0 Dashboard</Tooltip>. To learn more, see [Register APIs](/docs/get-started/auth0-overview/set-up-apis).

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">

Before you register any APIs in the Auth0 Dashboard, one API will already exist: the **Auth0 Management API**. To learn more about the features of the Management API and its available endpoints, see [Management API](https://auth0.com/docs/api/management/v2).

</Callout>

## Learn more
Expand All @@ -33,4 +31,4 @@ Before you register any APIs in the Auth0 Dashboard, one API will already exist:
* [Which OAuth 2.0 Flow Should I Use?](/docs/get-started/authentication-and-authorization-flow/which-oauth-2-0-flow-should-i-use)
* [Tokens](/docs/secure/tokens)
* [Register APIs](/docs/get-started/auth0-overview/set-up-apis)
* [API Settings](/docs/get-started/apis/api-settings)
* [API Settings](/docs/get-started/apis/api-settings)
4 changes: 2 additions & 2 deletions main/docs/get-started/apis/scopes.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: Understand the principle of scopes and explore general examples of their use.
sidebarTitle: Overview
title: Scopes
description: Understand the principle of scopes and explore general examples of their use.
---

Different pieces of user information are often stored across a number of online resources. Users may upload and store photos with a service like Flickr, keep digital files on Dropbox, and store contacts and events in Google Calendar or on Facebook.

Often, new applications will want to make use of the information that has already been created in an online resource. To do so, the application must ask for authorization to access this information on a user's behalf. Scopes define the specific actions applications can be allowed to do on a user's behalf.
Expand Down
52 changes: 25 additions & 27 deletions main/docs/get-started/applications.mdx
Original file line number Diff line number Diff line change
@@ -1,24 +1,35 @@
---
description: Learn the basics of registering and configuring your applications in Auth0.
sidebarTitle: Overview
title: Applications in Auth0
title: Application Types on Auth0
description: Learn about application types and the basics of registering and configuring applications on Auth0.
---
The term **application** or **app** in Auth0 does not imply any particular implementation characteristics. For example, it could be a native app that executes on a mobile device, a single-page application that executes on a browser, or a regular web application that executes on a server.

Auth0 categorizes apps based on these characteristics:
Auth0 categorizes applications based on these characteristics:

* **Application type**: To add authentication to your application, you must register it in the <Tooltip tip="Auth0 Dashboard: Auth0's main product to configure your services." cta="View Glossary" href="/docs/glossary?term=Auth0+Dashboard">Auth0 Dashboard</Tooltip> and select from one of the following application types:
* **Application type**, which can be either regular web applications, single-page web applications, native applications, or machine-to-machine applications.

+ **Regular web application**: Traditional web apps that perform most of their application logic on the server (such as Express.js or ASP.NET). To learn how to set up a regular web application, read [Register Regular Web Applications](/docs/get-started/auth0-overview/create-applications/regular-web-apps).
+ **Single page web application (SPA)**: JavaScript apps that perform most of their user interface logic in a web browser, communicating with a web server primarily using APIs (such as AngularJS + Node.js or React). To learn how to set up a Single-page web application, read [Register Single-Page Web Applications](/docs/get-started/auth0-overview/create-applications/single-page-web-apps).
+ **Native application**: Mobile or Desktop applications that run natively on a device (such as iOS or Android). To learn how to set up a native application, read [Register Native Applications](/docs/get-started/auth0-overview/create-applications/native-apps).
+ **Machine to machine (M2M) application**: Non-interactive applications, such as command-line tools, daemons, IoT devices, or services running on your backend. Typically, you use this option if you have a service that requires access to an API. To learn how to set up a native application, read [Register Machine-to-Machine Applications](/docs/get-started/auth0-overview/create-applications/machine-to-machine-apps).
* **Credential security**: According to the [OAuth 2.0 spec](https://tools.ietf.org/html/rfc6749#section-2.1), apps can be classified as either public or confidential; confidential apps can hold credentials securely, while public apps cannot. To learn more, read [Confidential and Public Applications](/docs/get-started/applications/confidential-and-public-applications).
* **Ownership**: Whether an app is classified as first- or third-party depends on app ownership and control. First-party apps are controlled by the same organization or person that owns the Auth0 domain. Third-party apps enable external parties or partners to securely access protected resources behind your API. To learn more, read [First-Party and Third-Party Applications](/docs/get-started/applications/first-party-and-third-party-applications).
* [Regular web applications](/docs/get-started/auth0-overview/create-applications/regular-web-apps) are traditional web apps that perform most of their application logic on the server (such as Express.js or ASP.NET).

## Manage applications settings
* [Single-page web applications (SPAs)](/docs/get-started/auth0-overview/create-applications/single-page-web-apps) are JavaScript apps that perform most of their user interface logic in a web browser, communicating with a web server primarily using APIs (such as AngularJS + Node.js or React).

You register applications in [Dashboard > Applications > Applications](https://manage.auth0.com/#/applications/{yourClientId}/settings). In addition to setting up applications in the Dashboard, you can also set up applications programmatically as described in the [OpenID Connect (OIDC) Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) specification.
* [Native applications](/docs/get-started/auth0-overview/create-applications/native-apps) are mobile or desktop applications that run natively on a device (such as iOS or Android).

* [Machine-to-machine (M2M) applications](/docs/get-started/auth0-overview/create-applications/machine-to-machine-apps) are non-interactive applications, such as command-line tools, daemons, IoT devices, or services running on your backend. Typically, you use this option if you have a service that requires access to an API.

* **Credential security** describes the app's ability to store secrets. Apps can be [public or confidential](/docs/get-started/applications/confidential-and-public-applications).

* Public applications cannot securely store credentials.

* Confidential applications can securely store credentials.

* **Ownership** describes the app's trust relationship (who owns and operates the application), which can be either [first-party and third-party](/docs/get-started/applications/first-party-and-third-party-applications).

* First-party apps are controlled by the same organization or person that owns the Auth0 domain.

* Third-party apps enable external parties or partners to securely access protected resources behind your API.

## Manage application settings

You register applications in [Dashboard > Applications > Applications](https://manage.auth0.com/#/applications/{yourClientId}/settings). In addition to setting up applications in the Dashboard, you can also set up applications programmatically as described in the [OpenID Connect (OIDC) Dynamic Client Registration 1.0](https://openid.net/specs/openid-connect-registration-1_0.html) specification.

You can set up a more complex configuration that allows users to log in differently for different apps. To learn more, read [Multi-Tenant Application Best Practices](/docs/get-started/auth0-overview/create-tenants/multi-tenant-apps-best-practices) and [Create Multiple Tenants](/docs/get-started/auth0-overview/create-tenants/create-multiple-tenants).

Expand All @@ -28,10 +39,6 @@ By default, Auth0 enables all connections associated with your tenant when you c

You can [monitor apps](/docs/deploy-monitor/monitor/monitor-applications) and perform end-to-end testing using your own tests. Auth0 stores [log data](/docs/deploy-monitor/logs) including Dashboard administrator actions, successful and failed user authentications, and password change requests. You can use log streaming in [Auth0 Marketplace](https://marketplace.auth0.com/features/log-streaming) to export your log data and use tools like Sumo Logic, Splunk, or Mixpanel to analyze and store your log data.

## Remove applications

You can [remove an application](/docs/get-started/applications/remove-applications) using the Dashboard or the <Tooltip tip="Management API: A product to allow customers to perform administrative tasks." cta="View Glossary" href="/docs/glossary?term=Management+API">Management API</Tooltip>.

## Manage client secrets

A <Tooltip tip="Authorization Server: Centralized server that contributes to defining the boundaries of a user’s access. For example, your authorization server can control the data, tasks, and features available to a user." cta="View Glossary" href="/docs/glossary?term=client+secret">client secret</Tooltip> is a secret known only to your application and the <Tooltip tip="Client Secret: Secret used by a client (application) to authenticate with the Authorization Server; it should be known to only the client and the Authorization Server and must be sufficiently random to not be guessable." cta="View Glossary" href="/docs/glossary?term=authorization+server">authorization server</Tooltip>. It protects your resources by only granting [tokens](/docs/secure/tokens) to authorized requestors.
Expand All @@ -41,12 +48,3 @@ Protect your client secrets and **never** include them in mobile or browser-base
## Grant types

Auth0 provides many different authentication and authorization grant types or flows and allows you to indicate which grant types are appropriate based on the `grant_types` property of your Auth0-registered app. To learn more, read [Application Grant Types](/docs/get-started/applications/application-grant-types).

## Learn more

* [Application Settings](/docs/get-started/applications/application-settings)
* [Confidential and Public Applications](/docs/get-started/applications/confidential-and-public-applications)
* [First-Party and Third-Party Applications](/docs/get-started/applications/first-party-and-third-party-applications)
* [Application Grant Types](/docs/get-started/applications/application-grant-types)
* [Subdomain URL Placeholders](/docs/get-started/applications/wildcards-for-subdomains)
* [Dynamic Application Registration](/docs/get-started/applications/dynamic-client-registration)
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
description: Describe the settings related to applications available in the Auth0 Dashboard.
title: Application Settings
description: Describe the settings related to applications available in the Auth0 Dashboard.
---

On the [Applications](https://manage.auth0.com/#/applications) page of the Dashboard, locate your application in the list, and click its name to view the available settings.

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
Expand Down
Loading
Loading