Skip to content

Commit 20d078f

Browse files
rkhoriandertamigoodall
authored andcommitted
Standardize titles/references to flows and use of "single-page" terminology (#7524)
* Standardize references to flows and use of single-page term * Update application section index with new filenames * Update auth sequence media * fix missing link
1 parent ed6d8d4 commit 20d078f

File tree

171 files changed

+792
-396
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

171 files changed

+792
-396
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Description
167167
:::
168168

169169
::: panel-warning Security Warning
170-
It is important to understand that the Authorization Code flow should only be used in cases such as a Regular Web Application where the Client Secret can be safely stored. In cases such as a Single Page Application, the Client Secret is available to the client (in the web browser), so the integrity of the Client Secret cannot be maintained. That is why the [Single-Page Login Flow](/flows/concepts/single-page-login-flow) is more appropriate in that case.
170+
It is important to understand that the Authorization Code flow should only be used in cases such as a Regular Web Application where the Client Secret can be safely stored. In cases such as a Single-Page Application, the Client Secret is available to the client (in the web browser), so the integrity of the Client Secret cannot be maintained. That is why the [Implicit Flow](/flows/concepts/implicit) is more appropriate in that case.
171171
:::
172172
```
173173

articles/api-auth/config/using-the-auth0-dashboard.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ useCase: secure-api
1010

1111
# Set up a Client Credentials Grant using the Dashboard
1212

13-
Auth0 lets you authorize applications that have the **Client Credentials** grant type enabled to call APIs using the [Machine-to-Machine (M2M) Flow](/flows/concepts/m2m-flow).
13+
Auth0 lets you authorize applications that have the **Client Credentials** grant type enabled to call APIs using the [Client Credentials Flow](/flows/concepts/client-credentials).
1414

1515
By default, the **Client Credentials** grant is enabled for all Machine-to-Machine Applications and Regular Web Applications, but they are _not yet_ authorized to call any API.
1616

@@ -29,7 +29,7 @@ To authorize the applications to call an API:
2929
## Keep reading
3030

3131
:::next-steps
32-
* [Call API using the Machine-to-Machine (M2M) Flow](/flows/guides/m2m-flow/call-api-using-m2m-flow)
32+
* [Call API using the Client Credentials Flow](/flows/guides/client-credentials/call-api-client-credentials)
3333
* [How to change the scopes and add custom claims to a token using Hooks](/api-auth/tutorials/client-credentials/customize-with-hooks)
3434
* [How to add custom claims to a token using Rules](/scopes/current/sample-use-cases#add-custom-claims-to-a-token)
3535
:::

articles/api-auth/config/using-the-management-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ useCase: secure-api
1111

1212
# Set up a Client Credentials Grant using the Management API
1313

14-
Auth0 lets you authorize applications that have the 'Client Credentials' grant type enabled to call APIs using the [Machine-to-Machine (M2M) Flow](/flows/concepts/m2m-flow).
14+
Auth0 lets you authorize applications that have the 'Client Credentials' grant type enabled to call APIs using the [Client Credentials Flow](/flows/concepts/client-credentials).
1515

1616
By default, all Machine-to-Machine Applications and Regular Web Applications have the 'Client Credentials' grant enabled, but they are not authorized to call any API.
1717

@@ -59,12 +59,12 @@ Sample response:
5959
}
6060
```
6161

62-
That's it, you are done! Now that all the elements are in place, you can request Access Tokens for your API from Auth0 using the Machine-to-Machine (M2M) Flow.
62+
That's it, you are done! Now that all the elements are in place, you can request Access Tokens for your API from Auth0 using the Client Credentials Flow.
6363

6464
## Keep reading
6565

6666
:::next-steps
67-
* [Call API using the Machine-to-Machine (M2M) Flow](/flows/guides/m2m-flow/call-api-using-m2m-flow)
67+
* [Call API using the Client Credentials Flow](/flows/guides/client-credentials/call-api-client-credentials)
6868
* [How to change the scopes and add custom claims to a token using Hooks](/api-auth/tutorials/client-credentials/customize-with-hooks)
6969
* [How to add custom claims to a token using Rules](/scopes/current/sample-use-cases#add-custom-claims-to-a-token)
7070
:::

articles/api-auth/dynamic-client-registration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Also, keep in mind that third-party developers are not allowed to modify the app
111111

112112
Now that you have a Client ID and Secret, you can configure your application to authenticate users with Auth0.
113113

114-
We will go through a simple example, that shows how to call an API from a client-side web app, using the [Single-Page Login Flow](/flows/guides/single-page-login-flow/call-api-using-single-page-login-flow). For a list of tutorials on how to authenticate and authorize users, based on your application type, see the [API Authorization](/api-auth) page.
114+
We will go through a simple example, that shows how to call an API from a client-side web app, using the [Implicit Flow](/flows/guides/implicit/call-api-implicit). For a list of tutorials on how to authenticate and authorize users, based on your application type, see the [API Authorization](/api-auth) page.
115115

116116
First, you need to configure your application to send the user to the authorization URL:
117117

articles/api-auth/grant/hybrid.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ useCase:
1313

1414
The Hybrid Flow is an OpenID Connect (OIDC) flow that draws from the following:
1515

16-
1. [Regular Web App Login Flow](/flows/concepts/regular-web-app-login-flow)
17-
2. [Single-Page Login Flow](/flows/concepts/single-page-login-flow)
16+
1. [Authorization Code Flow](/flows/concepts/auth-code)
17+
2. [Implicit Flow](/flows/concepts/implicit)
1818

1919
The Hybrid Flow enables use cases where your application can immediately use an ID token to access information about the user while obtaining an authorization code that can be exchanged for an Access Token (therefore gaining access to protected resources for an extended period of time).
2020

2121
## Background
2222

23-
With the [Regular Web App Login Flow](/flows/concepts/regular-web-app-login-flow), Auth0 sends you an authorization code, which your app then sends in to retrieve tokens. Your application authenticates itself with a Client ID and Client Secret stored securely on your server.
23+
With the [Authorization Code Flow](/flows/concepts/auth-code), Auth0 sends you an authorization code, which your app then sends in to retrieve tokens. Your application authenticates itself with a Client ID and Client Secret stored securely on your server.
2424

25-
On the other hand, the [Single-Page Login Flow](/flows/concepts/single-page-login-flow) allows you to request Access Tokens without needing to authenticate your application. Auth0 verifies your app's identity based on the provided redirect URI. Because of this, you shouldn't utilize long-lived Access Tokens, and you cannot use Refresh Tokens.
25+
On the other hand, the [Implicit Flow](/flows/concepts/implicit) allows you to request Access Tokens without needing to authenticate your application. Auth0 verifies your app's identity based on the provided redirect URI. Because of this, you shouldn't utilize long-lived Access Tokens, and you cannot use Refresh Tokens.
2626

2727
## The Hybrid Flow
2828

@@ -60,7 +60,7 @@ For details on how to implement this using Auth0, refer to [Execute the Hybrid F
6060
- [Execute the Hybrid Flow](/api-auth/tutorials/hybrid-flow)
6161
- [How to configure an API in Auth0](/apis)
6262
- [Why you should always use Access Tokens to secure an API](/api-auth/why-use-access-tokens-to-secure-apis)
63-
- [Application authentication for regular web apps](/flows/concepts/regular-web-app-login-flow)
64-
- [Application authentication for single-page apps](/flows/concepts/single-page-login-flow)
63+
- [Application authentication for regular web apps](/flows/concepts/auth-code)
64+
- [Application authentication for single-page apps](/flows/concepts/implicit)
6565
- [Tokens used by Auth0](/tokens)
6666
:::

articles/api-auth/grant/implicit.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ useCase:
1414

1515
<%= include('../../_includes/_pipeline2') %>
1616

17-
In order to access an API from a [client-side app](/quickstart/spa) (typically a Single Page Application or a Mobile Application), you need to implement the OAuth 2.0 **Implicit Grant**. In this document we will see how this flow works.
17+
In order to access an API from a [client-side app](/quickstart/spa) (typically a Single-Page Application or a Mobile Application), you need to implement the OAuth 2.0 **Implicit Grant**. In this document we will see how this flow works.
1818

1919
::: note
2020
If you need a refresher on the OAuth 2.0 protocol, you can go through our [OAuth 2.0](/protocols/oauth2) article.
@@ -32,7 +32,7 @@ Once the user authenticates, the application receives the Access Token in the ha
3232

3333
1. Auth0 authenticates the user. The first time the user goes through this flow a consent page will be shown where the permissions, that will be given to the Application, are listed (for example: post messages, list contacts, and so forth).
3434

35-
1. Auth0 redirects the user to the app with an [Access Token](/tokens/overview-access-tokens) (and optionally an [ID Token](/tokens/id-token)) in the hash fragment of the URI. The app can now extract the tokens from the hash fragment. In a Single Page Application (SPA) this would be done using Javascript and in a Mobile Application this is typically handled by interacting with a Web View.
35+
1. Auth0 redirects the user to the app with an [Access Token](/tokens/overview-access-tokens) (and optionally an [ID Token](/tokens/id-token)) in the hash fragment of the URI. The app can now extract the tokens from the hash fragment. In a Single-Page Application (SPA) this would be done using Javascript and in a Mobile Application this is typically handled by interacting with a Web View.
3636

3737
1. The app can use the Access Token to call the API on behalf of the user.
3838

articles/api-auth/grant/password.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ useCase:
1717
Highly trusted applications can use this flow to access APIs. In this flow the end-user is asked to fill in credentials (username/password), typically using an interactive form. This information is sent to the backend and from there to Auth0.
1818

1919
You should use this flow **only if** the following apply:
20-
- The application is absolutely trusted with the user's credentials. For [Single-Page Applications](/flows/concepts/single-page-login-flow) and [Native/Mobile Apps](/flows/concepts/mobile-login-flow) we recommend using web flows instead.
21-
- Using a redirect-based flow is not possible. If this is not the case and redirects are possible in your application, you should use the [Regular Web App Login Flow](/flows/concepts/regular-web-app-login-flow) instead.
20+
- The application is absolutely trusted with the user's credentials. For [Single-Page Applications](/flows/concepts/implicit) and [Native/Mobile Apps](/flows/concepts/auth-code-pkce) we recommend using web flows instead.
21+
- Using a redirect-based flow is not possible. If this is not the case and redirects are possible in your application, you should use the [Authorization Code Flow](/flows/concepts/auth-code) instead.
2222

2323
::: note
2424
If you need a refresher on the OAuth 2.0 protocol, you can go through our [OAuth 2.0](/protocols/oauth2) article.

articles/api-auth/index.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -38,44 +38,44 @@ In this page you can find a list of resources that can help you secure your APIs
3838
</p>
3939
</li>
4040
<li>
41-
<i class="icon icon-budicon-715"></i><a href="/flows/guides/regular-web-app-login-flow/call-api-using-regular-web-app-login-flow">Call Your API from a Regular Web App</a>
41+
<i class="icon icon-budicon-715"></i><a href="/flows/guides/auth-code/call-api-auth-code">Call Your API from a Regular Web App</a>
4242
<p>
4343
If your application executes on a server and you want to configure it to use OAuth 2.0 to access an API, read these docs.
4444
</p>
4545
<ul>
4646
<li>
47-
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/regular-web-app-login-flow">Overview of the flow</a>
47+
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/auth-code">Overview of the flow</a>
4848
</li>
4949
<li>
50-
<i class="icon icon-budicon-695"></i><a href/flows/guides/regular-web-app-login-flow/call-api-using-regular-web-app-login-flow">Executing the flow</a>
50+
<i class="icon icon-budicon-695"></i><a href/flows/guides/auth-code/call-api-auth-code">Executing the flow</a>
5151
</li>
5252
</ul>
5353
</li>
5454
<li>
55-
<i class="icon icon-budicon-715"></i><a href="/flows/guides/mobile-login-flow/call-api-using-mobile-login-flow">Call Your API from a Native/Mobile App</a>
55+
<i class="icon icon-budicon-715"></i><a href="/flows/guides/auth-code-pkce/call-api-auth-code-pkce">Call Your API from a Native/Mobile App</a>
5656
<p>
5757
If your application is a native app and you want to configure it to use OAuth 2.0 to access an API, read these docs.
5858
</p>
5959
<ul>
6060
<li>
61-
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/mobile-login-flow">Overview of the flow</a>
61+
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/auth-code-pkce">Overview of the flow</a>
6262
</li>
6363
<li>
64-
<i class="icon icon-budicon-695"></i><a href="/flows/guides/mobile-login-flow/call-api-using-mobile-login-flow">Executing the flow</a>
64+
<i class="icon icon-budicon-695"></i><a href="/flows/guides/auth-code-pkce/call-api-auth-code-pkce">Executing the flow</a>
6565
</li>
6666
</ul>
6767
</li>
6868
<li>
69-
<i class="icon icon-budicon-715"></i><a href="/flows/guides/single-page-login-flow/call-api-using-single-page-login-flow">Call Your API from a Single-Page App</a>
69+
<i class="icon icon-budicon-715"></i><a href="/flows/guides/implicit/call-api-implicit">Call Your API from a Single-Page App</a>
7070
<p>
7171
If your application is a JavaScript-centric app executing on the browser, and you want to configure it to use OAuth 2.0 to access an API, read these docs.
7272
</p>
7373
<ul>
7474
<li>
75-
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/single-page-login-flow">Overview of the flow</a>
75+
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/implicit">Overview of the flow</a>
7676
</li>
7777
<li>
78-
<i class="icon icon-budicon-695"></i><a href="/flows/guides/single-page-login-flow/call-api-using-single-page-login-flow">Executing the flow</a>
78+
<i class="icon icon-budicon-695"></i><a href="/flows/guides/implicit/call-api-implicit">Executing the flow</a>
7979
</li>
8080
<li>
8181
<i class="icon icon-budicon-695"></i><a href="/api-auth/tutorials/silent-authentication">Silent authentication for SPAs</a>
@@ -89,16 +89,16 @@ In this page you can find a list of resources that can help you secure your APIs
8989
</ul>
9090
</li>
9191
<li>
92-
<i class="icon icon-budicon-715"></i><a href="/flows/guides/m2m-flow/call-api-using-m2m-flow">Call Your API from a Machine-to-Machine App</a>
92+
<i class="icon icon-budicon-715"></i><a href="/flows/guides/client-credentials/call-api-client-credentials">Call Your API from a Machine-to-Machine App</a>
9393
<p>
9494
If you want to implement server-to-server interaction, and you want to configure it to use OAuth 2.0, read these docs.
9595
</p>
9696
<ul>
9797
<li>
98-
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/m2m-flow">Overview of the flow</a>
98+
<i class="icon icon-budicon-695"></i><a href="/flows/concepts/client-credentials">Overview of the flow</a>
9999
</li>
100100
<li>
101-
<i class="icon icon-budicon-695"></i><a href="/flows/guides/m2m-flow/call-api-using-m2m-flow">Executing the flow</a>
101+
<i class="icon icon-budicon-695"></i><a href="/flows/guides/client-credentials/call-api-client-credentials">Executing the flow</a>
102102
</li>
103103
<li>
104104
<i class="icon icon-budicon-695"></i><a href="/api-auth/config/using-the-auth0-dashboard">How to set up a Client Grant using the Dashboard</a>

0 commit comments

Comments
 (0)