-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs 3689 auth explorer update #10394
Changes from 9 commits
858c4f3
27e9116
d5a5e86
6ddd024
c0513ab
377fdd3
50751d6
2af37d3
3e8f969
c7c4505
326321c
8aa2579
6be0644
5836e59
690e390
52a45fc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
<h5 class="http-method-box"> | ||
<h3 class="http-method-box"> | ||
<span class="badge ${http_badge.toLowerCase()}" href="${link}">${http_method}</span> | ||
<span class="path" href="${link}">${path}</span> | ||
</h5> | ||
</h3> |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
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. | ||
|
||
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>. | ||
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](https://auth0.com/docs/secure/highly-regulated-identity#advanced-security-with-openid-connect-fapi-)</dfn> and <dfn data-key="security-assertion-markup-language">[SAML](/protocols/saml)</dfn>. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. small nitpick: you could shorten FAPI link by removing "https://auth0.com/docs" from "/secure/highly-regulated-identity#advanced-security-with-openid-connect-fapi-" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need the entire URL here instead of just the relative path, as in the other places? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank-you for catching this one ^ |
||
|
||
:::note | ||
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- | |
|
||
### Client ID and Client Secret | ||
|
||
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. | ||
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. | ||
|
||
If you are using **Post**, you must send this data in the JSON body of your request. | ||
|
||
|
@@ -44,7 +44,7 @@ An example is the [Revoke Refresh Token endpoint](#revoke-refresh-token). This o | |
|
||
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. | ||
|
||
An example is the [Implicit Grant](#implicit-grant). | ||
An example is the [Implicit Grant](#implicit-flow). | ||
|
||
### mTLS Authentication | ||
|
||
|
@@ -85,16 +85,38 @@ Each request should be sent with a Content-Type of `application/json`. | |
|
||
You can test the endpoints using the [Authentication API Debugger](/extensions/authentication-api-debugger). | ||
|
||
### Test with the Authentication API Debugger | ||
### Authentication API Debugger | ||
|
||
The [Authentication API Debugger](/extensions/authentication-api-debugger) is an Auth0 extension you can use to test several endpoints of the Authentication API. | ||
|
||
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. | ||
<%= include('../../_includes/_test-this-endpoint') %> | ||
|
||
### Configure Connections | ||
|
||
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). | ||
|
||
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). | ||
|
||
1. At the *OAuth2 / OIDC* tab, select **OAuth2 / OIDC Login**. | ||
|
||
### Use Authentication API Debugger | ||
Configure other endpoints with the following options: | ||
|
||
- 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**. | ||
- SAML SSO: On the *Other Flows* tab, select **SAML**. | ||
- WS-Federation: On the *Other Flows* tab, select **WS-Federation**. | ||
- Logout: On the *Other Flows* tab, select **Logout**, or **Logout (Federated)** to log the user out of the identity provider as well. | ||
- Legacy Login: On the *OAuth2 / OIDC* tab, set the fields **ID Token**, **Refresh Token** and **Target Client ID**. Click **Delegation**. | ||
- Legacy Delegation: On the *OAuth2 / OIDC* tab, set **Username** and **Password**. Click **Resource Owner Endpoint**. | ||
- Legacy Resource Owner: On the *OAuth2 / OIDC* tab, set the **Username** and **Password**, then select **Resource Owner Endpoint**. | ||
|
||
### Use Authentication API Debugger with authentications flows | ||
|
||
Configure authentication flows with the following options: | ||
- 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**. | ||
- 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**. | ||
- Client Credential Flow: On the *OAuth2 / OIDC* tab, select **OAuth2 Client Credentials**. | ||
|
||
Note that its URL varies according to your tenant's region: | ||
- <a href="https://${account.tenant}.us.webtask.io/auth0-authentication-api-debugger" target="_blank">US West</a> | ||
- <a href="https://${account.tenant}.eu.webtask.io/auth0-authentication-api-debugger" target="_blank">Europe Central</a> | ||
- <a href="https://${account.tenant}.au.webtask.io/auth0-authentication-api-debugger" target="_blank">Australia</a> | ||
|
||
## Errors | ||
|
||
|
@@ -120,4 +142,4 @@ Note that for database connections Auth0 limits certain types of repeat login at | |
|
||
If you have problems or need help with your case, you can always reach out to our [Support](${env.DOMAIN_URL_SUPPORT}). | ||
|
||
Note that if you have a free subscription plan, and you are not in your 22-day trial period, you will not be able to access or open tickets in the [Support Center](${env.DOMAIN_URL_SUPPORT}). In this case, you can seek support through the [Auth0 Community](https://community.auth0.com/). For more info on our support program, refer to [Support Options](/support). | ||
Note that if you have a free subscription plan, and you are not in your 22-day trial period, you will not be able to access or open tickets in the [Support Center](${env.DOMAIN_URL_SUPPORT}). In this case, you can seek support through the [Auth0 Community](https://community.auth0.com/). For more info on our support program, refer to [Support Options](/support). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to keep these disabled globally instead of using
<!-- markdownlint-disable MDXYZ-->
in the affected files?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For Authentication API Explorer, yes. The errors I'm getting are because the tech is old and we don't have the resources or people to yet to update the experience completely. Once the Explorer is merged, I plan to go back and update this file ^
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand! Let's keep it like this, then