Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,8 @@
"group": "Help center",
"pages": [
"help-center/openapi-url-fetch-fails-during-build",
"help-center/domain-already-claimed-by-another-organization"
"help-center/domain-already-claimed-by-another-organization",
"help-center/configure-oauth-with-auth0"
]
}
]
Expand Down
3 changes: 2 additions & 1 deletion es.json
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,8 @@
"group": "Centro de ayuda",
"pages": [
"es/help-center/openapi-url-fetch-fails-during-build",
"es/help-center/domain-already-claimed-by-another-organization"
"es/help-center/domain-already-claimed-by-another-organization",
"es/help-center/configure-oauth-with-auth0"
]
}
]
Expand Down
52 changes: 52 additions & 0 deletions es/help-center/configure-oauth-with-auth0.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Configurar la autenticación OAuth 2.0 con Auth0"
description: "Configura Auth0 como proveedor de identidad OAuth 2.0 para un sitio privado de documentación de Mintlify, incluyendo las URLs de los endpoints, el registro del callback y el control de acceso basado en grupos."
keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"]
---

Auth0 es un proveedor de identidad compatible con OAuth 2.0 y OIDC, por lo que se integra directamente con el soporte nativo de OAuth 2.0 de Mintlify. Esta página asigna los endpoints y ajustes de Auth0 a los campos de [Configuración de autenticación](/es/deploy/authentication-setup#oauth-2-0). Usa la página canónica de configuración para el flujo completo y consulta esta para los valores específicos de Auth0.

La autenticación OAuth 2.0 está disponible en el plan Enterprise.

## Requisitos previos

- Un tenant de Auth0. Anota el dominio de tu tenant, por ejemplo `your-tenant.us.auth0.com`.
- Una **Regular Web Application** de Auth0 creada para tu sitio de documentación.
- El client ID y el client secret de esa aplicación.

## Asigna Auth0 a los campos de OAuth de Mintlify

En tu panel de Mintlify, ve a [Authentication](https://app.mintlify.com/products/authentication), define la visibilidad del sitio como **Private** y elige **Custom** → **OAuth**. Rellena los campos con los siguientes valores de Auth0. Reemplaza `YOUR_AUTH0_DOMAIN` con el dominio de tu tenant.

| Campo de Mintlify | Valor de Auth0 |
|---|---|
| Authorization URL | `https://YOUR_AUTH0_DOMAIN/authorize` |
| Token URL | `https://YOUR_AUTH0_DOMAIN/oauth/token` |
| Client ID | Client ID de la aplicación en Auth0 |
| Client Secret | Client secret de la aplicación en Auth0 |
| Scopes | `openid profile email` (añade más si tu aplicación los necesita) |
| Info API URL (opcional) | `https://YOUR_AUTH0_DOMAIN/userinfo` |
| Logout URL (opcional) | `https://YOUR_AUTH0_DOMAIN/v2/logout?returnTo=<url-encoded-return-url>` |

Guarda la configuración. Mintlify vuelve a desplegar tu sitio con la nueva configuración de autenticación.

## Registra la URL de redirección en Auth0

Copia la **Redirect URL** que aparece en la configuración de autenticación de Mintlify y añádela a tu aplicación de Auth0 en **Application URIs → Allowed Callback URLs**. Guarda la aplicación de Auth0. Sin este paso, Auth0 rechaza el flujo de inicio de sesión.

Si configuras una **Logout URL** en Mintlify, añade la misma URL de retorno a los **Allowed Logout URLs** de tu aplicación de Auth0.

## Control de acceso basado en grupos

Para restringir páginas a usuarios específicos de Auth0, tienes dos opciones.

- **Claims del token (recomendado).** Añade un claim de grupos al ID token o al access token mediante una [Auth0 Action](https://auth0.com/docs/customize/actions) y configura Mintlify para leerlo. Consulta [Usar grupos desde claims del token de OAuth](/es/deploy/authentication-setup#use-groups-from-oauth-token-claims). Si obtienes los grupos del ID token, mantén `openid` en tus scopes.
- **Info API URL.** Apunta Mintlify a `https://YOUR_AUTH0_DOMAIN/userinfo` o a tu propio endpoint que devuelva los datos del usuario en el [formato de datos de usuario](/es/deploy/authentication-setup#user-data-format). El endpoint debe aceptar `Authorization: Bearer <access_token>` y devolver los grupos en la respuesta.

Luego etiqueta las páginas o grupos de navegación con un valor `groups` que coincida para que solo los miembros de ese grupo puedan verlos.

## Solución de problemas

- **La URL de callback no coincide.** Auth0 bloquea el inicio de sesión y muestra un error de callback. Confirma que la URL de redirección en los **Allowed Callback URLs** de Auth0 coincide exactamente con la que aparece en la configuración de autenticación de Mintlify, incluyendo el protocolo y la ruta final.
- **Los usuarios inician sesión pero no ven contenido restringido.** Tu claim de grupos no está llegando a Mintlify. Confirma que la Auth0 Action añade el claim, que el `source` en Mintlify coincide con el token en el que lo configuraste (`id_token` o `access_token`) y que `groupsClaim` coincide con el nombre del claim.
- **El cierre de sesión no redirige de vuelta.** Auth0 requiere que la URL `returnTo` del enlace de cierre de sesión esté listada en los **Allowed Logout URLs** de la aplicación.
6 changes: 6 additions & 0 deletions es/organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ keywords: ["docs.json", "configuration", "setup", "mint.json"]

El archivo `docs.json` es el archivo de configuración central de tu sitio de documentación Mintlify. Controla la configuración global de tu sitio, incluyendo la identidad visual, la estructura de navegación, las integraciones, la configuración de la API y más. Piensa en él como el plano de tu sitio.

<div id="file-location">
## Ubicación del archivo
</div>

`docs.json` se ubica en la raíz del repositorio de tu documentación, junto con tus archivos de contenido. Edítalo en el [editor web](/es/editor/index) o directamente en tu repositorio con tu IDE preferido.

## Campos obligatorios

Debes definir cuatro campos para construir un sitio funcional.
Expand Down
3 changes: 2 additions & 1 deletion fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,8 @@
"group": "Centre d'aide",
"pages": [
"fr/help-center/openapi-url-fetch-fails-during-build",
"fr/help-center/domain-already-claimed-by-another-organization"
"fr/help-center/domain-already-claimed-by-another-organization",
"fr/help-center/configure-oauth-with-auth0"
]
}
]
Expand Down
52 changes: 52 additions & 0 deletions fr/help-center/configure-oauth-with-auth0.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Configurer l'authentification OAuth 2.0 avec Auth0"
description: "Configurez Auth0 comme fournisseur d'identité OAuth 2.0 pour un site de documentation Mintlify privé, y compris les URL d'endpoints, l'enregistrement du callback et le contrôle d'accès basé sur les groupes."
keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"]
---

Auth0 est un fournisseur d'identité conforme à OAuth 2.0 et OIDC, il s'intègre donc directement à la prise en charge native d'OAuth 2.0 de Mintlify. Cette page met en correspondance les endpoints et les paramètres d'Auth0 avec les champs de la page [Configuration de l'authentification](/fr/deploy/authentication-setup#oauth-2-0). Utilisez la page de configuration canonique pour le flux complet et consultez celle-ci pour les valeurs propres à Auth0.

L'authentification OAuth 2.0 est disponible sur le plan Enterprise.

## Prérequis

- Un tenant Auth0. Notez son domaine, par exemple `your-tenant.us.auth0.com`.
- Une **Regular Web Application** Auth0 créée pour votre site de documentation.
- L'identifiant client et le secret client de cette application.

## Mettre en correspondance Auth0 avec les champs OAuth de Mintlify

Dans votre tableau de bord Mintlify, accédez à [Authentication](https://app.mintlify.com/products/authentication), définissez la visibilité du site sur **Private**, puis choisissez **Custom** → **OAuth**. Renseignez les champs avec les valeurs Auth0 suivantes. Remplacez `YOUR_AUTH0_DOMAIN` par le domaine de votre tenant.

| Champ Mintlify | Valeur Auth0 |
|---|---|
| Authorization URL | `https://YOUR_AUTH0_DOMAIN/authorize` |
| Token URL | `https://YOUR_AUTH0_DOMAIN/oauth/token` |
| Client ID | Identifiant client de l'application depuis Auth0 |
| Client Secret | Secret client de l'application depuis Auth0 |
| Scopes | `openid profile email` (ajoutez-en d'autres si votre application en a besoin) |
| Info API URL (facultatif) | `https://YOUR_AUTH0_DOMAIN/userinfo` |
| Logout URL (facultatif) | `https://YOUR_AUTH0_DOMAIN/v2/logout?returnTo=<url-encoded-return-url>` |

Enregistrez les paramètres. Mintlify redéploie votre site avec la nouvelle configuration d'authentification.

## Enregistrer l'URL de redirection dans Auth0

Copiez la **Redirect URL** affichée dans vos paramètres d'authentification Mintlify et ajoutez-la à votre application Auth0 sous **Application URIs → Allowed Callback URLs**. Enregistrez l'application Auth0. Sans cette étape, Auth0 rejette le flux de connexion.

Si vous avez défini une **Logout URL** dans Mintlify, ajoutez la même URL de retour aux **Allowed Logout URLs** de votre application Auth0.

## Contrôle d'accès basé sur les groupes

Pour restreindre certaines pages à des utilisateurs Auth0 spécifiques, vous avez deux options.

- **Claims des jetons (recommandé).** Ajoutez un claim de groupes à l'ID token ou à l'access token avec une [Auth0 Action](https://auth0.com/docs/customize/actions) et configurez Mintlify pour le lire. Voir [Utiliser les groupes issus des claims des jetons OAuth](/fr/deploy/authentication-setup#use-groups-from-oauth-token-claims). Si vous récupérez les groupes depuis l'ID token, conservez `openid` dans vos scopes.
- **Info API URL.** Pointez Mintlify vers `https://YOUR_AUTH0_DOMAIN/userinfo` ou vers votre propre endpoint renvoyant des données utilisateur au [format des données utilisateur](/fr/deploy/authentication-setup#user-data-format). L'endpoint doit accepter `Authorization: Bearer <access_token>` et renvoyer les groupes dans la réponse.

Ensuite, taguez les pages ou les groupes de navigation avec une valeur `groups` correspondante afin que seuls les membres de ce groupe puissent les voir.

## Dépannage

- **Callback URL mismatch.** Auth0 bloque la connexion et affiche une erreur de callback. Vérifiez que l'URL de redirection dans les **Allowed Callback URLs** d'Auth0 correspond exactement à celle affichée dans vos paramètres d'authentification Mintlify, y compris le protocole et le chemin final.
- **Les utilisateurs se connectent mais ne voient aucun contenu restreint.** Votre claim de groupes n'atteint pas Mintlify. Vérifiez que l'Auth0 Action ajoute bien le claim, que la `source` définie dans Mintlify correspond au jeton sur lequel vous l'avez placé (`id_token` ou `access_token`), et que `groupsClaim` correspond au nom du claim.
- **La déconnexion ne redirige pas en arrière.** Auth0 exige que l'URL `returnTo` du lien de déconnexion soit listée sous les **Allowed Logout URLs** de l'application.
6 changes: 6 additions & 0 deletions fr/organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ keywords: ["docs.json", "configuration", "setup", "mint.json"]

Le fichier `docs.json` est le fichier de configuration central de votre site de documentation Mintlify. Il contrôle les paramètres globaux de votre site, y compris l'identité visuelle, la structure de navigation, les intégrations, les paramètres d'API et plus encore. Considérez-le comme le plan directeur de votre site.

<div id="file-location">
## Emplacement du fichier
</div>

`docs.json` se trouve à la racine de votre dépôt de documentation, aux côtés de vos fichiers de contenu. Modifiez-le dans l'[éditeur web](/fr/editor/index) ou directement dans votre dépôt avec votre IDE préféré.

## Champs obligatoires

Vous devez définir quatre champs pour construire un site fonctionnel.
Expand Down
52 changes: 52 additions & 0 deletions help-center/configure-oauth-with-auth0.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: "Configure OAuth 2.0 authentication with Auth0"
description: "Set up Auth0 as the OAuth 2.0 identity provider for a private Mintlify docs site: endpoint URLs, callback registration, and group-based access."
keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"]
---

Auth0 is an OAuth 2.0 and OIDC-compliant identity provider, so it plugs directly into Mintlify's built-in OAuth 2.0 support. This page maps Auth0's endpoints and settings onto the fields in [Authentication setup](/deploy/authentication-setup#oauth-2-0). Use the canonical setup page for the full flow and refer here for the Auth0-specific values.

OAuth 2.0 authentication is available on the Enterprise plan.

## Prerequisites

- An Auth0 tenant. Note your tenant domain, for example `your-tenant.us.auth0.com`.
- An Auth0 **Regular Web Application** created for your documentation site.
- The client ID and client secret for that application.

## Map Auth0 to Mintlify's OAuth fields

In your Mintlify dashboard, go to [Authentication](https://app.mintlify.com/products/authentication), set site visibility to **Private**, and choose **Custom** → **OAuth**. Fill in the fields with the following Auth0 values. Replace `YOUR_AUTH0_DOMAIN` with your tenant domain.

| Mintlify field | Auth0 value |
|---|---|
| Authorization URL | `https://YOUR_AUTH0_DOMAIN/authorize` |
| Token URL | `https://YOUR_AUTH0_DOMAIN/oauth/token` |
| Client ID | Application client ID from Auth0 |
| Client Secret | Application client secret from Auth0 |
| Scopes | `openid profile email` (add more if your app needs them) |
| Info API URL (optional) | `https://YOUR_AUTH0_DOMAIN/userinfo` |
| Logout URL (optional) | `https://YOUR_AUTH0_DOMAIN/v2/logout?returnTo=<url-encoded-return-url>` |

Save the settings. Mintlify redeploys your site with the new authentication configuration.

## Register the redirect URL in Auth0

Copy the **Redirect URL** shown in your Mintlify authentication settings and add it to your Auth0 application under **Application URIs → Allowed Callback URLs**. Save the Auth0 application. Without this step, Auth0 rejects the login flow.

If you set a **Logout URL** in Mintlify, add the same return URL to your Auth0 application's **Allowed Logout URLs**.

## Group-based access control

To restrict pages to specific Auth0 users, you have two options.

- **Token claims (recommended).** Add a groups claim to the ID token or access token with an [Auth0 Action](https://auth0.com/docs/customize/actions) and configure Mintlify to read it. See [Use groups from OAuth token claims](/deploy/authentication-setup#use-groups-from-oauth-token-claims). If you source groups from the ID token, keep `openid` in your scopes.
- **Info API URL.** Point Mintlify at `https://YOUR_AUTH0_DOMAIN/userinfo` or your own endpoint that returns user data in the [User data format](/deploy/authentication-setup#user-data-format). The endpoint must accept `Authorization: Bearer <access_token>` and return groups in the response.

Then tag pages or navigation groups with a matching `groups` value so only members of that group can see them.

## Troubleshooting

- **Callback URL mismatch.** Auth0 blocks the login and shows a callback error. Confirm the redirect URL in Auth0's **Allowed Callback URLs** exactly matches the one shown in your Mintlify authentication settings, including protocol and trailing path.
- **Users log in but see no restricted content.** Your groups claim is not reaching Mintlify. Confirm the Auth0 Action adds the claim, that `source` in Mintlify matches the token you set it on (`id_token` or `access_token`), and that `groupsClaim` matches the claim name.
- **Logout does not redirect back.** Auth0 requires the `returnTo` URL in the logout link to be listed under **Allowed Logout URLs** on the application.

Check warning on line 52 in help-center/configure-oauth-with-auth0.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

help-center/configure-oauth-with-auth0.mdx#L52

In general, use active voice instead of passive voice ('be listed').
4 changes: 4 additions & 0 deletions organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ keywords: ["docs.json", "configuration", "setup", "mint.json"]

The `docs.json` file is the central configuration file for your Mintlify documentation site. It controls your site's global settings, including visual branding, navigation structure, integrations, API settings, and more. Think of it as the blueprint for your site.

## File location

Store your `docs.json` file at the root of your documentation repository. If you have a monorepo, store your `docs.json` at the root of your documentation directory.

## Required fields

You must define four fields to build a working site.
Expand Down
3 changes: 2 additions & 1 deletion zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,8 @@
"group": "帮助中心",
"pages": [
"zh/help-center/openapi-url-fetch-fails-during-build",
"zh/help-center/domain-already-claimed-by-another-organization"
"zh/help-center/domain-already-claimed-by-another-organization",
"zh/help-center/configure-oauth-with-auth0"
]
}
]
Expand Down
Loading