> ## Documentation Index > Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt > Use this file to discover all available pages before exploring further. # Configuración de personalización > Muestra contenido personalizado según la autenticación del usuario y los datos de su perfil. La personalización adapta tu documentación para cada usuario cuando inicia sesión. Por ejemplo, puedes rellenar previamente sus claves de API, mostrar contenido específico según su plan o rol, u ocultar secciones a las que no necesitan acceder.
## Funciones de personalización
Personaliza el contenido con estas opciones de personalización.
### Prefill automático de API key
Rellena automáticamente los campos del área de pruebas de la API con valores específicos del usuario devolviendo nombres de campos que coincidan en tus datos de usuario. Los nombres de campos en tus datos de usuario deben coincidir exactamente con los nombres del área de pruebas de la API para que el prefill automático funcione.
### Contenido dinámico en MDX
Muestra contenido dinámico según la información del usuario, como el nombre, el plan o la organización, usando la variable `user`. ```jsx theme={null} ¡Bienvenido de vuelta, {user.firstName}! Tu plan {user.org?.plan} incluye... ``` Consulta la sección [Formato de datos del usuario](#user-data-format) a continuación para ver ejemplos detallados y orientación de implementación.
### Visibilidad de la página
Restringe qué páginas son visibles para tus usuarios añadiendo campos `groups` al frontmatter de tus páginas. De forma predeterminada, todas las páginas son visibles para todos los usuarios. Los usuarios solo verán las páginas de los `groups` a los que pertenecen. ```mdx theme={null} --- title: "Gestión de tus usuarios" description: "Agregar y eliminar usuarios de tu organización" groups: ["admin"] --- ```
## Formato de datos de usuario
Al implementar la personalización, tu sistema devuelve los datos de usuario en un formato específico que permite la personalización del contenido. Estos datos se pueden enviar como un objeto JSON bruto o dentro de un JWT firmado, según tu método de handshake. La estructura de los datos es la misma en ambos casos. ```tsx theme={null} type User = { expiresAt?: number; groups?: string[]; content?: Record; apiPlaygroundInputs?: { header?: Record; query?: Record; cookie?: Record; server?: Record; }; }; ``` Tiempo de expiración de la sesión en **segundos desde la época Unix**. Si el usuario carga una página después de este tiempo, sus datos almacenados se eliminan automáticamente y debe volver a autenticarse. Para intercambios con JWT: Esto es distinto del claim `exp` del JWT, que determina cuándo un JWT se considera inválido. Por seguridad, configura el claim `exp` del JWT con una duración corta (10 segundos o menos). Usa `expiresAt` para la duración real de la sesión (de horas a semanas). Lista de grupos a los que pertenece el usuario. Las páginas con `groups` coincidentes en su frontmatter son visibles para este usuario. **Ejemplo**: Un usuario con `groups: ["admin", "engineering"]` puede acceder a páginas etiquetadas con los grupos `admin` o `engineering`. Datos personalizados accesibles en tu contenido MDX a través de la variable `user`. Úsalos para realizar personalización dinámica en toda tu documentación. **Ejemplo básico**: ```json theme={null} { "firstName": "Ronan", "company": "Acme Corp", "plan": "Enterprise" } ``` **Uso en MDX**: ```mdx theme={null} Welcome back, {user.firstName}! Your {user.plan} plan includes... ``` Con el ejemplo de datos de `user`, esto se renderizaría como: Welcome back, Ronan! Your Enterprise plan includes... **Renderizado condicional avanzado**: ```jsx theme={null} Authentication is an enterprise feature. { user.org === undefined ? <>To access this feature, first create an account at the Mintlify dashboard. : user.org.plan !== 'enterprise' ? <>You are currently on the ${user.org.plan ?? 'free'} plan. See our pricing page for information about upgrading. : <>To request this feature for your enterprise org, contact your admin. } ``` La información en `user` solo está disponible para usuarios con sesión iniciada. Para usuarios sin iniciar sesión, el valor de `user` será `{}`. Para evitar que la página falle para usuarios sin iniciar sesión, usa siempre encadenamiento opcional en los campos de `user`. Por ejemplo, `{user.org?.plan}`. Valores específicos del usuario que rellenan previamente los campos del área de pruebas de la API. Ahorra tiempo a los usuarios al autocompletar sus datos cuando prueban APIs. **Ejemplo**: ```json theme={null} { "header": { "X-API-Key": "user_api_key_123" }, "server": { "subdomain": "foo" }, "query": { "org_id": "12345" } } ``` Si un usuario realiza solicitudes en un subdominio específico, puedes enviar `{ server: { subdomain: 'foo' } }` como un campo `apiPlaygroundInputs`. Este valor se rellenará previamente en cualquier página de la API con el valor `subdomain`. Los campos `header`, `query` y `cookie` solo se rellenarán previamente si forman parte de tu [esquema de seguridad de OpenAPI](https://swagger.io/docs/specification/authentication/). Si un campo está en las secciones `Authorization` o `Server`, se rellenará previamente. Crear un parámetro de encabezado estándar llamado `Authorization` no habilitará esta función.
### Ejemplo de datos de usuario
```json theme={null} { "expiresAt": 1735689600, "groups": ["admin", "beta-users"], "content": { "firstName": "Jane", "lastName": "Smith", "company": "TechCorp", "plan": "Enterprise", "region": "us-west" }, "apiPlaygroundInputs": { "header": { "Authorization": "Bearer abc123", "X-Org-ID": "techcorp" }, "server": { "environment": "production", "region": "us-west" } } } ```
## Configuración de la personalización
Selecciona el método de handshake que quieres configurar. ### Requisitos previos * Un sistema de inicio de sesión que pueda generar y firmar JWT * Un servicio backend que pueda crear URL de redirección ### Implementación 1. En tu dashboard, ve a [Autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Selecciona **Personalization**. 3. Selecciona **JWT**. 4. Ingresa la URL de tu flujo de inicio de sesión existente y selecciona **Guardar cambios**. 5. Selecciona **Generate new key**. 6. Almacena tu key de forma segura donde pueda accederla tu backend. Modifica tu flujo de inicio de sesión existente para incluir estos pasos después de que el usuario inicie sesión: * Crea un JWT que contenga la información del usuario que ha iniciado sesión en el formato `User`. Consulta la sección [User data format](#user-data-format) más arriba para obtener más información. * Firma el JWT con la clave secreta, usando el algoritmo ES256. * Crea una URL de redirección de vuelta a tu documentación, incluyendo el JWT como hash. ### Ejemplo Tu documentación está alojada en `docs.foo.com`. Quieres que tu documentación esté separada de tu dashboard (o no tienes un dashboard) y habilitar la personalización. Genera un secreto JWT. Luego, crea un endpoint de inicio de sesión en `https://foo.com/docs-login` que inicie un flujo de inicio de sesión hacia tu documentación. Después de verificar las credenciales del usuario: * Genera un JWT con los datos de usuario en el formato de Mintlify. * Firma el JWT y redirige a `https://docs.foo.com#{SIGNED_JWT}`. ```ts theme={null} import * as jose from 'jose'; import { Request, Response } from 'express'; const TWO_WEEKS_IN_MS = 1000 * 60 * 60 * 24 * 7 * 2; const signingKey = await jose.importPKCS8(process.env.MINTLIFY_PRIVATE_KEY, 'ES256'); export async function handleRequest(req: Request, res: Response) { const user = { expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), groups: res.locals.user.groups, content: { firstName: res.locals.user.firstName, lastName: res.locals.user.lastName, }, }; const jwt = await new jose.SignJWT(user) .setProtectedHeader({ alg: 'ES256' }) .setExpirationTime('10 s') .sign(signingKey); return res.redirect(`https://docs.foo.com#${jwt}`); } ``` ### Conservar anclajes de página Para redirigir a los usuarios a secciones específicas después de iniciar sesión, usa este formato de URL: `https://docs.foo.com/page#jwt={SIGNED_JWT}&anchor={ANCHOR}`. **Ejemplo**: * URL original: `https://docs.foo.com/quickstart#step-one` * URL de redirección: `https://docs.foo.com/quickstart#jwt={SIGNED_JWT}&anchor=step-one` ### Requisitos previos * Un servidor OAuth que admita el flujo de código de autorización con PKCE * Capacidad para crear un endpoint de API accesible mediante tokens de acceso de OAuth ### Implementación Crea un endpoint de API que: * Acepte tokens de acceso de OAuth para la autenticación. * Devuelva datos de usuario en el formato `User`. Consulta la sección [Formato de datos de usuario](#user-data-format) más arriba para obtener más información. * Defina los scopes de acceso. 1. En tu dashboard, ve a [Autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Selecciona **Personalization**. 3. Selecciona **OAuth** y configura estos campos: * **Authorization URL**: Tu endpoint de autorización de OAuth. * **Client ID**: Tu identificador de cliente de OAuth 2.0. * **Scopes**: Permisos a solicitar. Copia la cadena de scope **completa** (por ejemplo, para un scope como `provider.users.docs`, copia el `provider.users.docs` completo). Debe coincidir con los scopes del endpoint que configuraste en el primer paso. * **Token URL**: Tu endpoint de intercambio de tokens de OAuth. * **Info API URL**: Endpoint para recuperar datos de usuario para la personalización. Creado en el primer paso. 4. Selecciona **Guardar cambios** 1. Copia la **Redirect URL** desde tu [configuración de autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Agrega esta URL como una URL de redirección autorizada en la configuración de tu servidor OAuth. ### Ejemplo Tu documentación está alojada en `foo.com/docs` y tienes un servidor OAuth existente que admite el flujo PKCE. Quieres personalizar tu documentación en función de los datos del usuario. **Crea un endpoint de información de usuario** en `api.foo.com/docs/user-info`, que requiera un token de acceso de OAuth con el scope `provider.users.docs` y responda con los datos personalizados del usuario: ```json theme={null} { "content": { "firstName": "Jane", "lastName": "Doe" }, "groups": ["engineering", "admin"] } ``` **Configura los detalles de tu servidor OAuth** en tu dashboard: * **Authorization URL**: `https://auth.foo.com/authorization` * **Client ID**: `ydybo4SD8PR73vzWWd6S0ObH` * **Scopes**: `['docs-user-info']` * **Token URL**: `https://auth.foo.com/exchange` * **Info API URL**: `https://api.foo.com/docs/user-info` **Configura tu servidor OAuth** para permitir redirecciones a tu URL de callback. ### Requisitos previos * Un dashboard o portal de usuario con autenticación de sesión basada en cookies. * Capacidad para crear un endpoint de API en el mismo origen o subdomain que tu dashboard. * Si tu dashboard está en `foo.com`, la **URL de la API** debe comenzar con `foo.com` o `*.foo.com`. * Si tu dashboard está en `dash.foo.com`, la **URL de la API** debe comenzar con `dash.foo.com` o `*.dash.foo.com`. * Tu documentación está alojada en el mismo domain o subdomain que tu dashboard. * Si tu dashboard está en `foo.com`, tus **docs** deben estar alojadas en `foo.com` o `*.foo.com`. * Si tu dashboard está en `*.foo.com`, tus **docs** deben estar alojadas en `foo.com` o `*.foo.com`. ### Implementación Crea un endpoint de API que: * Use tu autenticación de sesión existente para identificar a los usuarios * Devuelva datos de usuario en el formato `User` (consulta la sección [Formato de datos de usuario](#user-data-format) arriba) * Si el API domain y el docs domain **no coinciden exactamente**: * Agrega el docs domain al encabezado `Access-Control-Allow-Origin` de tu API (no debe ser `*`). * Establece el encabezado `Access-Control-Allow-Credentials` de tu API en `true`. Habilita los encabezados CORS solo en este endpoint específico, no en toda tu API del dashboard. 1. En tu dashboard, ve a [Autenticación](https://dashboard.mintlify.com/settings/deployment/authentication). 2. Selecciona **Personalization**. 3. Selecciona **Shared Session**. 4. Ingresa tu **Info API URL**, que es el endpoint del primer paso. 5. Ingresa tu **Login URL**, donde los usuarios inician sesión en tu dashboard. 6. Selecciona **Guardar cambios**. ### Ejemplos #### Dashboard en subdomain, docs en subdomain Tienes un dashboard en `dash.foo.com`, que utiliza autenticación de sesión basada en cookies. Tus rutas de API del dashboard están alojadas en `dash.foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `docs.foo.com`. **Proceso de configuración**: 1. **Crea el endpoint** `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. 2. **Agrega encabezados CORS** solo para esta ruta: * `Access-Control-Allow-Origin`: `https://docs.foo.com` * `Access-Control-Allow-Credentials`: `true` 3. **Configura la URL de la API** en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. #### Dashboard en subdomain, docs en raíz Tienes un dashboard en `dash.foo.com`, que utiliza autenticación de sesión basada en cookies. Tus rutas de API del dashboard están alojadas en `dash.foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `foo.com/docs`. **Proceso de configuración**: 1. **Crea el endpoint** `dash.foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. 2. **Agrega encabezados CORS** solo para esta ruta: * `Access-Control-Allow-Origin`: `https://foo.com` * `Access-Control-Allow-Credentials`: `true` 3. **Configura la URL de la API** en la configuración de autenticación: `https://dash.foo.com/api/docs/user-info`. #### Dashboard en raíz, docs en raíz Tienes un dashboard en `foo.com/dashboard`, que utiliza autenticación de sesión basada en cookies. Tus rutas de API del dashboard están alojadas en `foo.com/api`. Quieres configurar la personalización para tu documentación alojada en `foo.com/docs`. **Proceso de configuración**: 1. **Crea el endpoint** `foo.com/api/docs/user-info` que identifique a los usuarios mediante autenticación de sesión y responda con sus datos de usuario. 2. **Configura la URL de la API** en la configuración de autenticación: `https://foo.com/api/docs/user-info` No se necesita configuración de CORS, ya que el dashboard y la documentación comparten el mismo domain.