Skip to content

Commit 06c64f1

Browse files
author
Amanda VS
authored
Updated (#10408)
Updated spacing, incorrectly tagged badges in error, and full links showing as external. Also, missed updating the API Debugger headings
1 parent 248e423 commit 06c64f1

16 files changed

+14
-24
lines changed

‎articles/api/authentication/_introduction.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ An example is the [Implicit Grant](#implicit-flow).
4848

4949
### mTLS Authentication
5050

51-
Generate a certificate, either [self-signed](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#self-signed-certificates) or [certificate authority signed](https://auth0.com/docs/get-started/applications/configure-mtls/configure-mtls-for-a-client#certificate-authority-signed-certificates). Then, [set up the customer edge network](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge) that performs the mTLS handshake.
51+
Generate a certificate, either [self-signed](/get-started/applications/configure-mtls/configure-mtls-for-a-client#self-signed-certificates) or [certificate authority signed](/get-started/applications/configure-mtls/configure-mtls-for-a-client#certificate-authority-signed-certificates). Then, [set up the customer edge network](/get-started/applications/configure-mtls/set-up-the-customer-edge) that performs the mTLS handshake.
5252

5353
Once your edge network verifies the certificate, forward the request to the Auth0 edge network with the following headers:
5454

5555
- The Custom Domain API key as the `cname-api-key` header.
5656
- The client certificate as the `client-certificate` header.
57-
- The client certificate CA verification status as the `client-certificate-ca-verified` header. For more information, see [Forward the Request](https://auth0.com/docs/get-started/applications/configure-mtls/set-up-the-customer-edge#forward-the-request-).
57+
- The client certificate CA verification status as the `client-certificate-ca-verified` header. For more information, see [Forward the Request](/get-started/applications/configure-mtls/set-up-the-customer-edge#forward-the-request-).
5858

59-
To learn more, read [Authenticate with mTLS](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls).
59+
To learn more, read [Authenticate with mTLS](/get-started/authentication-and-authorization-flow/authenticate-with-mtls).
6060

6161
## Parameters
6262

@@ -99,7 +99,7 @@ The [Authentication API Debugger](/extensions/authentication-api-debugger) is an
9999

100100
1. At the *OAuth2 / OIDC* tab, select **OAuth2 / OIDC Login**.
101101

102-
### Use Authentication API Debugger
102+
### Endpoint options
103103
Configure other endpoints with the following options:
104104

105105
- 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**.
@@ -110,7 +110,7 @@ Configure other endpoints with the following options:
110110
- Legacy Delegation: On the *OAuth2 / OIDC* tab, set **Username** and **Password**. Click **Resource Owner Endpoint**.
111111
- Legacy Resource Owner: On the *OAuth2 / OIDC* tab, set the **Username** and **Password**, then select **Resource Owner Endpoint**.
112112

113-
### Use Authentication API Debugger with authentications flows
113+
### Authentications flows
114114

115115
Configure authentication flows with the following options:
116116
- 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**.

‎articles/api/authentication/_login.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<!-- markdownlint-disable MD024 MD033 -->
2-
32
# Login
43

54
<%= include('../../_includes/_http-method', {

‎articles/api/authentication/_logout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Logout
2-
32
## Auth0 Logout
3+
44
<%= include('../../_includes/_http-method', {
55
"http_badge": "badge-primary",
66
"http_method": "GET",

‎articles/api/authentication/_userinfo.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# User Profile
2-
32
## Get User Info
43

54
```http

‎articles/api/authentication/_wsfed-req.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# WS-Federation
2-
32
## Accept Request
43

54
```http

‎articles/api/authentication/api-authz/_auth-code-flow.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Authorization Code Flow
2-
32
## Authorize
43

54
```http

‎articles/api/authentication/api-authz/_auth-code-pkce.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Authorization Code Flow with PKCE
2-
32
## Authorize
3+
44
```http
55
GET https://${account.namespace}/authorize?
66
audience=API_IDENTIFIER&

‎articles/api/authentication/api-authz/_client-credential.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Client Credential Flow
2-
32
## Get Token
43

54
```http

‎articles/api/authentication/api-authz/_device-code.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Device Authorization Flow
2-
32
## Authorize
43

54
```http

‎articles/api/authentication/api-authz/_highly-regulated.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Authorization Code Flow with Enhanced Privacy Protection
2+
23
## Push Authorization Requests (PAR)
34

45
<%= include('../../../_includes/_http-method', {
@@ -85,13 +86,12 @@ Content-Type: application/json
8586
::: note
8687
Highly Regulated Identity is currently available for Enterprise customers under Limited Early Access. To learn more about this program, contact [Auth0 Support](http://support.auth0.com/).
8788
:::
88-
<br></br>
8989

9090
Authorization Code Flow with [Pushed Authorization Requests (PAR)](/get-started/authentication-and-authorization-flow/authorization-code-flow/authorization-code-flow-with-par) uses the `/oauth/par` endpoint to allow applications to send the authorization parameters usually sent in a `GET` request to `/authorize`. PAR uses a POST method from the backend to keep parameter values secure. The `/oauth/par` endpoint accepts all authorization parameters which can be proivided to `/authorize`. Assuming the call to the `/oauth/par` endpoint is valid, Auth0 will respond with a `redirect_uri` value that can be used as a parameter for the `/authorize` endpoint.
9191

9292
Assuming the call to the `/oauth/par` endpoint is valid, Auth0 will respond with a `redirect_uri` value also used as a parameter for the `/authorize` endpoint. To learn more about configuring PAR, read [Configure Pushed Authorization Requests (PAR)](/get-started/applications/configure-par).
9393

94-
## Request Parameters
94+
### Request Parameters
9595
| Parameter | Description |
9696
|:-----------------|:------------|
9797
|`authorization_details`| Requested permissions for each resource. Similar to scopes. To learn more, read [RAR reference documention](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authorization-code-flow/authorization-code-flow-with-rar). |
@@ -108,7 +108,7 @@ Assuming the call to the `/oauth/par` endpoint is valid, Auth0 will respond with
108108
| `prompt` | Can be used to force a particular prompt to display, e.g. `prompt=consent` will always display the consent prompt.|
109109
| `organization` | ID of the organization to use when authenticating a user. When not provided, if your application is configured to **Display Organization Prompt**, the user will be able to enter the organization name when authenticating. |
110110

111-
## Remarks
111+
### Remarks
112112
- To make a call to the PAR endpoint, you must:
113113
- Set the request content type as `application/x-www-form-urlencoded`
114114
- Use `strings` for all passed parameters
@@ -142,7 +142,7 @@ The `/authorize` endpoint will respond based on the parameters passed to the `/o
142142
| `client_id` <br/><span class="label label-danger">Required</span> | The `client_id` of your application. |
143143
| `request_uri` <br/><span class="label label-danger">Required</span> | The `request_uri` value that was received from the `/oauth/par` endpoint. |
144144

145-
### Exchange an Authorization Code for a Token
145+
## Exchange an Authorization Code for a Token
146146

147147
<%= include('../../../_includes/_http-method', {
148148
"http_badge": "badge-primary",

‎articles/api/authentication/api-authz/_implicit.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Implicit Flow
2-
32
## Authorize
43

54
```http

‎articles/api/authentication/api-authz/_resource-owner.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Resource Owner Password Flow
2-
32
## Get Token
3+
44
```http
55
POST https://${account.namespace}/oauth/token
66
Content-Type: application/x-www-form-urlencoded

‎articles/api/authentication/errors/_oauth-revoke.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
| Status | JSON Response |
44
| :--------------- | :------------ |
55
|<span class="badge badge-info">200</span> Success | `{"error": "invalid_request", "error_description": "..."}`</br> The <dfn data-key="refresh-token">Refresh Token</dfn> is revoked, does not exist, or was not issued to the client making the revocation request|
6-
|<span class="badge badge-info">400</span> Bad Request | `{"error": "invalid_request", "error_description": "..."}` he required parameters were not sent in the request.|
7-
|<span class="badge badge-info">401</span> Unauthorized | `{"error": "invalid_client", "error_description": "..."}`</br> The request is not authorized. Check that the client credentials `client_id` and client_secret` are present in the request and hold valid values. |
6+
|<span class="badge badge-danger">400</span> Bad Request | `{"error": "invalid_request", "error_description": "..."}` The required parameters were not sent in the request.|
7+
|<span class="badge badge-danger">401</span> Unauthorized | `{"error": "invalid_client", "error_description": "..."}`</br> The request is not authorized. Check that the client credentials `client_id` and client_secret` are present in the request and hold valid values. |

‎articles/api/authentication/legacy/_linking.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Account Linking
2-
32
## Link
43

54
::: warning

‎articles/api/authentication/legacy/_login.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<!-- markdownlint-disable -->
22
# Login
3-
43
## Social with Provider's Access Token
54

65
```http

‎articles/api/authentication/legacy/_userinfo.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<!-- markdownlint-disable MD024 MD033 -->
22

33
# User Profile
4-
54
## Get Token Info
65

76
```http

0 commit comments

Comments
 (0)