Skip to content

Mintlify updates (verified) #98

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 25, 2025
Merged

Mintlify updates (verified) #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
041cdb6
updates
gabrielraeder Sep 25, 2025
1ba6da5
fix: updates color for hover effect on links
gabrielraeder Sep 25, 2025
b75e5aa
fix: removes opacity from steps
gabrielraeder Sep 25, 2025
3c5fa73
fix: fixes css styles
gabrielraeder Sep 25, 2025
02cbf56
fix: fixes quickstart callout colors
gabrielraeder Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions main/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
"claude"
]
},
"fonts": {
"heading": {
"family": "Aeonik",
"source": "https://mintlify-assets.b-cdn.net/Aeonik/Aeonik-Regular.woff2",
"format": "woff2"
}
},
"navigation": {
"tabs": [
{
Expand Down Expand Up @@ -2454,5 +2461,10 @@
"socials": {
"github": "https://github.com/auth0/docs"
}
},
"seo": {
"metatags": {
"canonical": "https://auth0.com/docs/"
}
}
}
100 changes: 50 additions & 50 deletions main/docs/android-development-keystores-hashes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
---
'og:description': Instructions on acquiring development keystores/key hashes during
Android app development.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Android Development Keystores and Key Hashes
'og:url': https://auth0.com/docs/
permalink: android-development-keystores-hashes
title: Android Development Keystores and Key Hashes
'twitter:description': Instructions on acquiring development keystores/key hashes
during Android app development.
'twitter:title': Android Development Keystores and Key Hashes
---
When creating a new <Tooltip tip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows." cta="View Glossary" href="/docs/glossary?term=OAuth">OAuth</Tooltip> Credential for many connections you will need to provide the SHA-1 of the certificate you're using to sign your application. When completing your Application's configuration in the [Auth0 Dashboard](https://manage.auth0.com/#) you will also need to provide the SHA-256 value.
Locate the certificate you're using to sign your application. If you don't have one you can generate it. For production applications, you should do this.
During development, you can sign your application with the default `android.keystore` certificate that was generated automatically for you when you installed the SDK. In this example we're going to use this default keystore. To generate the key hashes using this keystore follow the examples below.
## Generating your key hashes
**On Windows:**
`keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android`
**On Linux / macOS:**
`keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android`
**Sample output:**
`Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
MD5: AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
SHA256: 15:B9:F9:33:9F:E4:E3:68:C2:10:49:17:5D:A8:77:12:7C:8E:57:E9:FF:B7:23:EA:CC:DD:56:08:06:C9:5E:33
Signature algorithm name: SHA256withRSA
Version: 3`
## Using your key hashes
Once you have your key hashes output, copy the resulting SHA256 value and go to your application's settings in the [Auth0 Dashboard](https://manage.auth0.com/#/applications). Click "Show Advanced Settings", and in the "Device Settings" tab, under "Android", fill the "App Package Name" with your application's package name, and the "Key Hashes" field with the SHA256 value you copied. Don't forget to save the changes.
---
description: Instructions on acquiring development keystores/key hashes during
Android app development.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Android Development Keystores and Key Hashes
'og:url': https://auth0.com/docs/
permalink: android-development-keystores-hashes
title: Android Development Keystores and Key Hashes
'twitter:description': Instructions on acquiring development keystores/key hashes
during Android app development.
'twitter:title': Android Development Keystores and Key Hashes
---
When creating a new <Tooltip tip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows." cta="View Glossary" href="/docs/glossary?term=OAuth">OAuth</Tooltip> Credential for many connections you will need to provide the SHA-1 of the certificate you're using to sign your application. When completing your Application's configuration in the [Auth0 Dashboard](https://manage.auth0.com/#) you will also need to provide the SHA-256 value.

Locate the certificate you're using to sign your application. If you don't have one you can generate it. For production applications, you should do this.

During development, you can sign your application with the default `android.keystore` certificate that was generated automatically for you when you installed the SDK. In this example we're going to use this default keystore. To generate the key hashes using this keystore follow the examples below.

## Generating your key hashes

**On Windows:**

`keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android`

**On Linux / macOS:**

`keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android`

**Sample output:**

`Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
MD5: AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
SHA256: 15:B9:F9:33:9F:E4:E3:68:C2:10:49:17:5D:A8:77:12:7C:8E:57:E9:FF:B7:23:EA:CC:DD:56:08:06:C9:5E:33
Signature algorithm name: SHA256withRSA
Version: 3`

## Using your key hashes

Once you have your key hashes output, copy the resulting SHA256 value and go to your application's settings in the [Auth0 Dashboard](https://manage.auth0.com/#/applications). Click "Show Advanced Settings", and in the "Device Settings" tab, under "Android", fill the "App Package Name" with your application's package name, and the "Key Hashes" field with the SHA256 value you copied. Don't forget to save the changes.

If you don't add the Callback URL to the application settings nor the Key Hashes to the application's device settings, the Auth0 server won't return the call result to your application.
110 changes: 55 additions & 55 deletions main/docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
---
'og:description': Learn about Auth0's Management and Authentication APIs.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Auth0 APIs
'og:url': https://auth0.com/docs/
permalink: api
sidebarTitle: Overview
title: Auth0 APIs
'twitter:description': Learn about Auth0's Management and Authentication APIs.
'twitter:title': Auth0 APIs
---
Auth0 exposes the following APIs for developers to consume in their applications.
## Authentication API
The Authentication API exposes identity functionality for Auth0 and supported identity protocols (including <Tooltip tip="OpenID: Open standard for authentication that allows applications to verify users' identities without collecting and storing login information." cta="View Glossary" href="/docs/glossary?term=OpenID">OpenID</Tooltip> Connect, <Tooltip tip="OpenID: Open standard for authentication that allows applications to verify users' identities without collecting and storing login information." cta="View Glossary" href="/docs/glossary?term=OAuth">OAuth</Tooltip>, and <Tooltip tip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows." cta="View Glossary" href="/docs/glossary?term=SAML">SAML</Tooltip>).
Typically, you should consume this API through one of the Auth0 SDKs, such as [Auth0.js](/docs/libraries/auth0js), or a library like [Lock](/docs/libraries/lock). However, if you are building your authentication UI manually, you will need to call the Authentication API directly.
Some example tasks include:
* Get [tokens](/docs/secure/tokens) during authentication
* Request a user's profile using an [Access Token](/docs/secure/tokens/access-tokens)
* Exchange [Refresh Tokens](/docs/secure/tokens/refresh-tokens) for new <Tooltip tip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API." cta="View Glossary" href="/docs/glossary?term=Access+Tokens">Access Tokens</Tooltip>
* Request a challenge for [multi-factor authentication (MFA)](/docs/secure/multi-factor-authentication)
### API
Learn about and explore the requests and responses for the Auth0 Authentication API endpoints in your browser with the [Authentication API](https://auth0.com/docs/api/authentication).
## Management API
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> allows you to manage your Auth0 account programmatically, so you can automate configuration of your environment. Most of the tasks you can perform in the Auth0 Management Dashboard can also be performed programmatically by using this API.
Some example tasks include:
* Register your applications and APIs with Auth0
* Set up [connections](/docs/authenticate/identity-providers) with which your users can authenticate
* [Manage users](/docs/manage-users)
* [Link user accounts](/docs/manage-users/user-accounts/user-account-linking/link-user-accounts)
### Pagination
For Public Cloud tenants, Management API endpoints return a maximum of 50 results per response. When there are more results than can be returned in a response, include the `page` and `per_page` parameters in your request to retrieve more results.
See [Migrate to Management API v2 Endpoint Paginated Queries](/docs/troubleshoot/product-lifecycle/past-migrations/migrate-to-paginated-queries) for information on updating your applications.
### API Explorer
Learn about and use the Auth0 Management API in your browser with the [Management API Explorer](https://auth0.com/docs/api/management/v2).
### Management API v1 has been deprecated
The Management API v1 is deprecated and should not be used for new projects.
---
description: Learn about Auth0's Management and Authentication APIs.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Auth0 APIs
'og:url': https://auth0.com/docs/
permalink: api
sidebarTitle: Overview
title: Auth0 APIs
'twitter:description': Learn about Auth0's Management and Authentication APIs.
'twitter:title': Auth0 APIs
---
Auth0 exposes the following APIs for developers to consume in their applications.

## Authentication API

The Authentication API exposes identity functionality for Auth0 and supported identity protocols (including <Tooltip tip="OpenID: Open standard for authentication that allows applications to verify users' identities without collecting and storing login information." cta="View Glossary" href="/docs/glossary?term=OpenID">OpenID</Tooltip> Connect, <Tooltip tip="OpenID: Open standard for authentication that allows applications to verify users' identities without collecting and storing login information." cta="View Glossary" href="/docs/glossary?term=OAuth">OAuth</Tooltip>, and <Tooltip tip="OAuth 2.0: Authorization framework that defines authorization protocols and workflows." cta="View Glossary" href="/docs/glossary?term=SAML">SAML</Tooltip>).

Typically, you should consume this API through one of the Auth0 SDKs, such as [Auth0.js](/docs/libraries/auth0js), or a library like [Lock](/docs/libraries/lock). However, if you are building your authentication UI manually, you will need to call the Authentication API directly.

Some example tasks include:

* Get [tokens](/docs/secure/tokens) during authentication
* Request a user's profile using an [Access Token](/docs/secure/tokens/access-tokens)
* Exchange [Refresh Tokens](/docs/secure/tokens/refresh-tokens) for new <Tooltip tip="Access Token: Authorization credential, in the form of an opaque string or JWT, used to access an API." cta="View Glossary" href="/docs/glossary?term=Access+Tokens">Access Tokens</Tooltip>
* Request a challenge for [multi-factor authentication (MFA)](/docs/secure/multi-factor-authentication)

### API

Learn about and explore the requests and responses for the Auth0 Authentication API endpoints in your browser with the [Authentication API](https://auth0.com/docs/api/authentication).

## Management API

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> allows you to manage your Auth0 account programmatically, so you can automate configuration of your environment. Most of the tasks you can perform in the Auth0 Management Dashboard can also be performed programmatically by using this API.

Some example tasks include:

* Register your applications and APIs with Auth0
* Set up [connections](/docs/authenticate/identity-providers) with which your users can authenticate
* [Manage users](/docs/manage-users)
* [Link user accounts](/docs/manage-users/user-accounts/user-account-linking/link-user-accounts)

### Pagination

For Public Cloud tenants, Management API endpoints return a maximum of 50 results per response. When there are more results than can be returned in a response, include the `page` and `per_page` parameters in your request to retrieve more results.

See [Migrate to Management API v2 Endpoint Paginated Queries](/docs/troubleshoot/product-lifecycle/past-migrations/migrate-to-paginated-queries) for information on updating your applications.

### API Explorer

Learn about and use the Auth0 Management API in your browser with the [Management API Explorer](https://auth0.com/docs/api/management/v2).

### Management API v1 has been deprecated

The Management API v1 is deprecated and should not be used for new projects.

Management API v1 reached its End of Life on **July 13, 2020**. You may have been required to take action before that date to ensure no interruption to your service. Notifications were sent to customers that needed to complete this migration.
92 changes: 46 additions & 46 deletions main/docs/articles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
---
'og:description': Get started using Auth0. Implement authentication for any kind of
application in minutes.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Auth0 Docs
'og:url': https://auth0.com/docs/
permalink: articles
title: Auth0 Docs
'twitter:description': Get started using Auth0. Implement authentication for any kind
of application in minutes.
'twitter:title': Auth0 Docs
---
import {AuthDocsPipeline} from "/snippets/AuthDocsPipeline.mdx";
<AuthDocsPipeline/>
Rely on the Auth0 identity platform to add sophisticated authentication and authorization to your applications. Centralize and manage users from multiple identity providers and give them branded, seamless signup and login experiences. Finely control access with a degree of customization that can accommodate even the most complex security requirements. Easily deploy your implementation and monitor status and services.
<Card title="Get Started" href="/docs/get-started">
Learn the basics and begin building your authentication solution.
</Card><Card title="Authenticate" href="/docs/authenticate">
Define how your applications and APIs verify the identity of a user or device.
</Card><Card title="Manage Users" href="/docs/manage-users">
Store and manage custom details about your users.
</Card><Card title="Customize" href="/docs/customize">
Customize Auth0 using your own branding and extend our functionality to solve your unique identity needs.
</Card><Card title="Secure" href="/docs/secure">
Add multi-factor authentication and defend your application from bots, suspicious IPs, and password breaches.
</Card><Card title="Deploy and Monitor" href="/docs/deploy-monitor">
Deploy Auth0 for your applications and monitor system health and events.
</Card><Card title="Troubleshoot" href="/docs/troubleshoot">
Troubleshoot challenges, learn about Auth0’s different levels of support, and get help.
---
description: Get started using Auth0. Implement authentication for any kind of
application in minutes.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Auth0 Docs
'og:url': https://auth0.com/docs/
permalink: articles
title: Auth0 Docs
'twitter:description': Get started using Auth0. Implement authentication for any kind
of application in minutes.
'twitter:title': Auth0 Docs
---
import {AuthDocsPipeline} from "/snippets/AuthDocsPipeline.mdx";

<AuthDocsPipeline/>

Rely on the Auth0 identity platform to add sophisticated authentication and authorization to your applications. Centralize and manage users from multiple identity providers and give them branded, seamless signup and login experiences. Finely control access with a degree of customization that can accommodate even the most complex security requirements. Easily deploy your implementation and monitor status and services.

<Card title="Get Started" href="/docs/get-started">

Learn the basics and begin building your authentication solution.

</Card><Card title="Authenticate" href="/docs/authenticate">

Define how your applications and APIs verify the identity of a user or device.

</Card><Card title="Manage Users" href="/docs/manage-users">

Store and manage custom details about your users.

</Card><Card title="Customize" href="/docs/customize">

Customize Auth0 using your own branding and extend our functionality to solve your unique identity needs.

</Card><Card title="Secure" href="/docs/secure">

Add multi-factor authentication and defend your application from bots, suspicious IPs, and password breaches.

</Card><Card title="Deploy and Monitor" href="/docs/deploy-monitor">

Deploy Auth0 for your applications and monitor system health and events.

</Card><Card title="Troubleshoot" href="/docs/troubleshoot">

Troubleshoot challenges, learn about Auth0’s different levels of support, and get help.

</Card>
Loading