Skip to content

Commit 248e423

Browse files
Amanda VSpdillonnick-gagliardi
authored
Docs 3689 auth explorer update (#10394)
* Authentication API updates HRI addition * Updates for Auth API Exp HRI update Break out client grants #Learn More standardization Error pages into Markdown tables * Commits Clean-up Final markdown tables addition of fapi to glossary for HRI entry * Update _device-code.md Duplicate Learn More * Updates after local run review * Last commits for final fixes Fixes for the nav, flow files, updated error codes * Update articles/api/authentication/index.md Co-authored-by: Patrick Dillon <[email protected]> * Revoke has been added the the Refresh Token page * Update _introduction.md * First batch of commits * Small edits for older content * Last commits from HRI * Last edits for the smaller project * Remove pending redirect --------- Co-authored-by: Patrick Dillon <[email protected]> Co-authored-by: Nick Gagliardi <[email protected]>
1 parent 6c832b4 commit 248e423

38 files changed

+1331
-1639
lines changed

.markdownlint.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
{
22
"default": false,
33
"resultVersion": 1,
4-
"MD001": true,
4+
"MD001": false,
55
"MD002": true,
66
"MD003": true,
77
"MD005": true,
88
"MD006": true,
99
"MD011": true,
10-
"MD012": true,
10+
"MD012": false,
1111
"MD018": true,
1212
"MD019": true,
1313
"MD023": true,
14-
"MD024": true,
14+
"MD024": false,
1515
"MD025": true,
1616
"MD027": true,
17-
"MD031": true,
17+
"MD031": false,
1818
"MD034": true,
1919
"MD035": true,
2020
"MD037": true,

articles/_includes/_http-method.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h5 class="http-method-box">
1+
<h3 class="http-method-box">
22
<span class="badge ${http_badge.toLowerCase()}" href="${link}">${http_method}</span>
33
<span class="path" href="${link}">${path}</span>
4-
</h5>
4+
</h3>

articles/_includes/_test-this-endpoint.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
You can use our **Authentication API Debugger** extension to test this endpoint. To do so, you need to be logged in and have installed the [Authentication API Debugger extension](/extensions/authentication-api-debugger).
2-
1+
<!-- markdownlint-disable MD024 MD034 MD041-->
32
Click on **Install Debugger** to go to the article that explains how (you only have to do this once).
43

54
<%

articles/api/authentication/_change-password.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ curl --request POST \
5656

5757
Send a change password email to the user's provided email address and `connection`.
5858

59-
Optionally, you may provide an Organization ID to support Organization-specific variables in [customized email templates](https://auth0.com/docs/customize/email/email-templates#common-variables) and to include the `organization_id` and `organization_name` parameters in the **Redirect To** URL.
59+
Optionally, you may provide an Organization ID to support Organization-specific variables in [customized email templates](/customize/email/email-templates#common-variables) and to include the `organization_id` and `organization_name` parameters in the **Redirect To** URL.
6060

6161
Note: This endpoint only works for database connections.
6262

@@ -79,9 +79,9 @@ Note: This endpoint only works for database connections.
7979
* `X-RateLimit-Reset`: Remaining time until the rate limit (`X-RateLimit-Limit`) resets. The value is in [UTC epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
8080

8181

82-
### More Information
82+
### Learn More
8383

8484
- [Changing a User's Password](/connections/database/password-change)
8585
- [Password Strength in Auth0 Database Connections](/connections/database/password-strength)
8686
- [Password Options in Auth0 Database Connections](/connections/database/password-options)
87-
- [Auth0 API Rate Limit Policy](/policies/rate-limits)
87+
- [Auth0 API Rate Limit Policy](/troubleshoot/customer-support/operational-policies/rate-limit-policy/rate-limit-configurations)

articles/api/authentication/_introduction.md

+31-9
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Authentication API enables you to manage all aspects of user identity when you use Auth0. It offers endpoints so your users can log in, sign up, log out, access APIs, and more.
44

5-
The API supports various identity protocols, like <dfn data-key="openid">[OpenID Connect](/protocols/oidc)</dfn>, [OAuth 2.0](/protocols/oauth2), and <dfn data-key="security-assertion-markup-language">[SAML](/protocols/saml)</dfn>.
5+
The API supports various identity protocols, like <dfn data-key="openid">[OpenID Connect](/protocols/oidc)</dfn>, <dfn data-key="oath2"> [OAuth 2.0](/protocols/oauth2)</dfn>, <dfn data-key="fapi">[FAPI](/secure/highly-regulated-identity#advanced-security-with-openid-connect-fapi-)</dfn> and <dfn data-key="security-assertion-markup-language">[SAML](/protocols/saml)</dfn>.
66

77
:::note
88
This API is designed for people who feel comfortable integrating with RESTful APIs. If you prefer a more guided approach check out our [Quickstarts](/quickstarts) or our [Libraries](/libraries).
@@ -32,7 +32,7 @@ Generate a [client assertion](https://auth0.com/docs/get-started/authentication-
3232

3333
### Client ID and Client Secret
3434

35-
Send the Client ID and Client Secret. The method you can use to send this data is determined by the [Token Endpoint Authentication Method](https://auth0.com/docs/get-started/applications/confidential-and-public-applications/view-application-type) configured for your application.
35+
Send the Client ID and Client Secret. The method you can use to send this data is determined by the [Token Endpoint Authentication Method](/get-started/applications/confidential-and-public-applications/view-application-type) configured for your application.
3636

3737
If you are using **Post**, you must send this data in the JSON body of your request.
3838

@@ -44,7 +44,7 @@ An example is the [Revoke Refresh Token endpoint](#revoke-refresh-token). This o
4444

4545
Send the Client ID. For public applications (applications that cannot hold credentials securely, such as SPAs or mobile apps), we offer some endpoints that can be accessed using only the Client ID.
4646

47-
An example is the [Implicit Grant](#implicit-grant).
47+
An example is the [Implicit Grant](#implicit-flow).
4848

4949
### mTLS Authentication
5050

@@ -85,16 +85,38 @@ Each request should be sent with a Content-Type of `application/json`.
8585

8686
You can test the endpoints using the [Authentication API Debugger](/extensions/authentication-api-debugger).
8787

88-
### Test with the Authentication API Debugger
88+
### Authentication API Debugger
8989

9090
The [Authentication API Debugger](/extensions/authentication-api-debugger) is an Auth0 extension you can use to test several endpoints of the Authentication API.
9191

92-
If it's the first time you use it, you have to install it using the [dashboard](${manage_url}/#/extensions). Once you do, you are ready to configure your app's settings and run your tests.
92+
<%= include('../../_includes/_test-this-endpoint') %>
93+
94+
### Configure Connections
95+
96+
1. On the *Configuration* tab, set the fields **Application** (select the application you want to use for the test) and **Connection** (the name of the social connection to use).
97+
98+
1. Copy the <dfn data-key="callback">**Callback URL**</dfn> and set it as part of the **Allowed Callback URLs** of your [Application Settings](${manage_url}/#/applications).
99+
100+
1. At the *OAuth2 / OIDC* tab, select **OAuth2 / OIDC Login**.
101+
102+
### Use Authentication API Debugger
103+
Configure other endpoints with the following options:
104+
105+
- Passwordless: On the *OAuth2 / OIDC* tab, set **Username** to the user's phone number if `connection=sms`, or the user's email if `connection=email`, and **Password** to the user's verification code. Click **Resource Owner Endpoint**.
106+
- SAML SSO: On the *Other Flows* tab, select **SAML**.
107+
- WS-Federation: On the *Other Flows* tab, select **WS-Federation**.
108+
- Logout: On the *Other Flows* tab, select **Logout**, or **Logout (Federated)** to log the user out of the identity provider as well.
109+
- Legacy Login: On the *OAuth2 / OIDC* tab, set the fields **ID Token**, **Refresh Token** and **Target Client ID**. Click **Delegation**.
110+
- Legacy Delegation: On the *OAuth2 / OIDC* tab, set **Username** and **Password**. Click **Resource Owner Endpoint**.
111+
- Legacy Resource Owner: On the *OAuth2 / OIDC* tab, set the **Username** and **Password**, then select **Resource Owner Endpoint**.
112+
113+
### Use Authentication API Debugger with authentications flows
114+
115+
Configure authentication flows with the following options:
116+
- Authorization Code Flow: On the *OAuth2 / OIDC* tab, set the field **Authorization Code** to the code you retrieved from [Authorization Code Grant](/get-started/authentication-and-authorization-flow/authorization-code-flow), and the **Code Verifier** to the key. Click **OAuth2 Code Exchange**.
117+
- Authorization Code Flow + PKCE: On the *OAuth2 / OIDC* tab, set the field **Authorization Code** to the code you retrieved from [Authorization Code Grant](/get-started/authentication-and-authorization-flow/authorization-code-flow-with-pkce), and the **Code Verifier** to the key. Click **OAuth2 Code Exchange**.
118+
- Client Credential Flow: On the *OAuth2 / OIDC* tab, select **OAuth2 Client Credentials**.
93119

94-
Note that its URL varies according to your tenant's region:
95-
- <a href="https://${account.tenant}.us.webtask.io/auth0-authentication-api-debugger" target="_blank">US West</a>
96-
- <a href="https://${account.tenant}.eu.webtask.io/auth0-authentication-api-debugger" target="_blank">Europe Central</a>
97-
- <a href="https://${account.tenant}.au.webtask.io/auth0-authentication-api-debugger" target="_blank">Australia</a>
98120

99121
## Errors
100122

0 commit comments

Comments
 (0)