Skip to content

Commit 4b87a2b

Browse files
authored
Merge pull request #98 from mintlify-onboarding/main
Mintlify updates (verified)
2 parents 5036bdc + 02cbf56 commit 4b87a2b

File tree

1,423 files changed

+264238
-264215
lines changed

Some content is hidden

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

1,423 files changed

+264238
-264215
lines changed

main/docs.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@
1919
"claude"
2020
]
2121
},
22+
"fonts": {
23+
"heading": {
24+
"family": "Aeonik",
25+
"source": "https://mintlify-assets.b-cdn.net/Aeonik/Aeonik-Regular.woff2",
26+
"format": "woff2"
27+
}
28+
},
2229
"navigation": {
2330
"tabs": [
2431
{
@@ -2454,5 +2461,10 @@
24542461
"socials": {
24552462
"github": "https://github.com/auth0/docs"
24562463
}
2464+
},
2465+
"seo": {
2466+
"metatags": {
2467+
"canonical": "https://auth0.com/docs/"
2468+
}
24572469
}
24582470
}
Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,51 @@
1-
---
2-
'og:description': Instructions on acquiring development keystores/key hashes during
3-
Android app development.
4-
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
5-
'og:title': Android Development Keystores and Key Hashes
6-
'og:url': https://auth0.com/docs/
7-
permalink: android-development-keystores-hashes
8-
title: Android Development Keystores and Key Hashes
9-
'twitter:description': Instructions on acquiring development keystores/key hashes
10-
during Android app development.
11-
'twitter:title': Android Development Keystores and Key Hashes
12-
---
13-
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.
14-
15-
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.
16-
17-
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.
18-
19-
## Generating your key hashes
20-
21-
**On Windows:**
22-
23-
`keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android`
24-
25-
**On Linux / macOS:**
26-
27-
`keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android`
28-
29-
**Sample output:**
30-
31-
`Alias name: androiddebugkey
32-
Creation date: Jan 01, 2013
33-
Entry type: PrivateKeyEntry
34-
Certificate chain length: 1
35-
Certificate[1]:
36-
Owner: CN=Android Debug, O=Android, C=US
37-
Issuer: CN=Android Debug, O=Android, C=US
38-
Serial number: 4aa9b300
39-
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
40-
Certificate fingerprints:
41-
MD5: AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
42-
SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
43-
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
44-
Signature algorithm name: SHA256withRSA
45-
Version: 3`
46-
47-
## Using your key hashes
48-
49-
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.
50-
1+
---
2+
description: Instructions on acquiring development keystores/key hashes during
3+
Android app development.
4+
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
5+
'og:title': Android Development Keystores and Key Hashes
6+
'og:url': https://auth0.com/docs/
7+
permalink: android-development-keystores-hashes
8+
title: Android Development Keystores and Key Hashes
9+
'twitter:description': Instructions on acquiring development keystores/key hashes
10+
during Android app development.
11+
'twitter:title': Android Development Keystores and Key Hashes
12+
---
13+
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.
14+
15+
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.
16+
17+
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.
18+
19+
## Generating your key hashes
20+
21+
**On Windows:**
22+
23+
`keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android`
24+
25+
**On Linux / macOS:**
26+
27+
`keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android`
28+
29+
**Sample output:**
30+
31+
`Alias name: androiddebugkey
32+
Creation date: Jan 01, 2013
33+
Entry type: PrivateKeyEntry
34+
Certificate chain length: 1
35+
Certificate[1]:
36+
Owner: CN=Android Debug, O=Android, C=US
37+
Issuer: CN=Android Debug, O=Android, C=US
38+
Serial number: 4aa9b300
39+
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
40+
Certificate fingerprints:
41+
MD5: AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
42+
SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
43+
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
44+
Signature algorithm name: SHA256withRSA
45+
Version: 3`
46+
47+
## Using your key hashes
48+
49+
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.
50+
5151
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.

main/docs/api.mdx

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
1-
---
2-
'og:description': Learn about Auth0's Management and Authentication APIs.
3-
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
4-
'og:title': Auth0 APIs
5-
'og:url': https://auth0.com/docs/
6-
permalink: api
7-
sidebarTitle: Overview
8-
title: Auth0 APIs
9-
'twitter:description': Learn about Auth0's Management and Authentication APIs.
10-
'twitter:title': Auth0 APIs
11-
---
12-
Auth0 exposes the following APIs for developers to consume in their applications.
13-
14-
## Authentication API
15-
16-
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>).
17-
18-
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.
19-
20-
Some example tasks include:
21-
22-
* Get [tokens](/docs/secure/tokens) during authentication
23-
* Request a user's profile using an [Access Token](/docs/secure/tokens/access-tokens)
24-
* 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>
25-
* Request a challenge for [multi-factor authentication (MFA)](/docs/secure/multi-factor-authentication)
26-
27-
### API
28-
29-
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).
30-
31-
## Management API
32-
33-
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.
34-
35-
Some example tasks include:
36-
37-
* Register your applications and APIs with Auth0
38-
* Set up [connections](/docs/authenticate/identity-providers) with which your users can authenticate
39-
* [Manage users](/docs/manage-users)
40-
* [Link user accounts](/docs/manage-users/user-accounts/user-account-linking/link-user-accounts)
41-
42-
### Pagination
43-
44-
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.
45-
46-
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.
47-
48-
### API Explorer
49-
50-
Learn about and use the Auth0 Management API in your browser with the [Management API Explorer](https://auth0.com/docs/api/management/v2).
51-
52-
### Management API v1 has been deprecated
53-
54-
The Management API v1 is deprecated and should not be used for new projects.
55-
1+
---
2+
description: Learn about Auth0's Management and Authentication APIs.
3+
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
4+
'og:title': Auth0 APIs
5+
'og:url': https://auth0.com/docs/
6+
permalink: api
7+
sidebarTitle: Overview
8+
title: Auth0 APIs
9+
'twitter:description': Learn about Auth0's Management and Authentication APIs.
10+
'twitter:title': Auth0 APIs
11+
---
12+
Auth0 exposes the following APIs for developers to consume in their applications.
13+
14+
## Authentication API
15+
16+
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>).
17+
18+
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.
19+
20+
Some example tasks include:
21+
22+
* Get [tokens](/docs/secure/tokens) during authentication
23+
* Request a user's profile using an [Access Token](/docs/secure/tokens/access-tokens)
24+
* 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>
25+
* Request a challenge for [multi-factor authentication (MFA)](/docs/secure/multi-factor-authentication)
26+
27+
### API
28+
29+
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).
30+
31+
## Management API
32+
33+
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.
34+
35+
Some example tasks include:
36+
37+
* Register your applications and APIs with Auth0
38+
* Set up [connections](/docs/authenticate/identity-providers) with which your users can authenticate
39+
* [Manage users](/docs/manage-users)
40+
* [Link user accounts](/docs/manage-users/user-accounts/user-account-linking/link-user-accounts)
41+
42+
### Pagination
43+
44+
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.
45+
46+
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.
47+
48+
### API Explorer
49+
50+
Learn about and use the Auth0 Management API in your browser with the [Management API Explorer](https://auth0.com/docs/api/management/v2).
51+
52+
### Management API v1 has been deprecated
53+
54+
The Management API v1 is deprecated and should not be used for new projects.
55+
5656
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.

main/docs/articles.mdx

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
1-
---
2-
'og:description': Get started using Auth0. Implement authentication for any kind of
3-
application in minutes.
4-
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
5-
'og:title': Auth0 Docs
6-
'og:url': https://auth0.com/docs/
7-
permalink: articles
8-
title: Auth0 Docs
9-
'twitter:description': Get started using Auth0. Implement authentication for any kind
10-
of application in minutes.
11-
'twitter:title': Auth0 Docs
12-
---
13-
import {AuthDocsPipeline} from "/snippets/AuthDocsPipeline.mdx";
14-
15-
<AuthDocsPipeline/>
16-
17-
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.
18-
19-
<Card title="Get Started" href="/docs/get-started">
20-
21-
Learn the basics and begin building your authentication solution.
22-
23-
</Card><Card title="Authenticate" href="/docs/authenticate">
24-
25-
Define how your applications and APIs verify the identity of a user or device.
26-
27-
</Card><Card title="Manage Users" href="/docs/manage-users">
28-
29-
Store and manage custom details about your users.
30-
31-
</Card><Card title="Customize" href="/docs/customize">
32-
33-
Customize Auth0 using your own branding and extend our functionality to solve your unique identity needs.
34-
35-
</Card><Card title="Secure" href="/docs/secure">
36-
37-
Add multi-factor authentication and defend your application from bots, suspicious IPs, and password breaches.
38-
39-
</Card><Card title="Deploy and Monitor" href="/docs/deploy-monitor">
40-
41-
Deploy Auth0 for your applications and monitor system health and events.
42-
43-
</Card><Card title="Troubleshoot" href="/docs/troubleshoot">
44-
45-
Troubleshoot challenges, learn about Auth0’s different levels of support, and get help.
46-
1+
---
2+
description: Get started using Auth0. Implement authentication for any kind of
3+
application in minutes.
4+
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
5+
'og:title': Auth0 Docs
6+
'og:url': https://auth0.com/docs/
7+
permalink: articles
8+
title: Auth0 Docs
9+
'twitter:description': Get started using Auth0. Implement authentication for any kind
10+
of application in minutes.
11+
'twitter:title': Auth0 Docs
12+
---
13+
import {AuthDocsPipeline} from "/snippets/AuthDocsPipeline.mdx";
14+
15+
<AuthDocsPipeline/>
16+
17+
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.
18+
19+
<Card title="Get Started" href="/docs/get-started">
20+
21+
Learn the basics and begin building your authentication solution.
22+
23+
</Card><Card title="Authenticate" href="/docs/authenticate">
24+
25+
Define how your applications and APIs verify the identity of a user or device.
26+
27+
</Card><Card title="Manage Users" href="/docs/manage-users">
28+
29+
Store and manage custom details about your users.
30+
31+
</Card><Card title="Customize" href="/docs/customize">
32+
33+
Customize Auth0 using your own branding and extend our functionality to solve your unique identity needs.
34+
35+
</Card><Card title="Secure" href="/docs/secure">
36+
37+
Add multi-factor authentication and defend your application from bots, suspicious IPs, and password breaches.
38+
39+
</Card><Card title="Deploy and Monitor" href="/docs/deploy-monitor">
40+
41+
Deploy Auth0 for your applications and monitor system health and events.
42+
43+
</Card><Card title="Troubleshoot" href="/docs/troubleshoot">
44+
45+
Troubleshoot challenges, learn about Auth0’s different levels of support, and get help.
46+
4747
</Card>

0 commit comments

Comments
 (0)