Overview

Controla quién puede ver tu documentación y personaliza su experiencia

Los planes Pro incluyen autenticación con contraseña.

Los planes Enterprise incluyen todos los métodos de autenticación.

Elige entre tres enfoques para gestionar el acceso y personalizar tu documentación según la información del usuario y tus necesidades de seguridad:

• Autenticación completa: Privacidad total de todo el contenido con personalización completa.
• Autenticación parcial: Control de acceso por página con personalización completa.
• Personalización: Personalización del contenido sin garantías de seguridad. Todo el contenido sigue siendo de acceso público.

Ejemplos de casos de uso

Elige autenticación completa cuando:

• Crees documentación interna de la empresa que contenga información confidencial
• Documentes APIs propietarias que requieran verificación de usuarios
• Elabores guías de implementación específicas para clientes

Elige autenticación parcial cuando:

• Ofrezcas guías públicas de introducción con funciones avanzadas privadas
• Publiques documentación de código abierto con secciones empresariales privadas

Elige personalización cuando:

• Crees documentación pública de API que muestre ejemplos específicos para cada usuario
• Crees sitios de marketing que personalicen el contenido según los perfiles de usuario
• Ofrezcas tutoriales públicos que se adapten a las preferencias o niveles de habilidad de los usuarios

Métodos de handshake

Elige el método que mejor se adapte a tu infraestructura actual y a tus requisitos de seguridad.

Método	Disponible para	Complejidad de configuración	Ideal para
JWT (JSON Web Token)	Todos los enfoques	Media	Flujos de inicio de sesión personalizados, máximo control de seguridad
OAuth 2.0	Todos los enfoques	Alta	Proveedores de autenticación de terceros, seguridad empresarial
Mintlify Dashboard	Solo Autenticación	Baja	Equipos que ya usan el dashboard de Mintlify
Contraseña	Solo Autenticación	Baja	Acceso compartido simple sin personalización
Sesión compartida	Solo Personalización	Baja	Apps con autenticación basada en sesión existente

Cuándo usar cada método

JWT (JSON Web Token): Úsalo cuando ya tengas un sistema de autenticación y quieras tener control total del flujo de inicio de sesión. Ideal para la gestión personalizada de usuarios o cuando necesites desacoplar el acceso a la documentación de tu aplicación principal.

OAuth 2.0: Úsalo cuando quieras aprovechar proveedores de autenticación de terceros (Google, GitHub, etc.) o necesites estándares de seguridad de nivel empresarial. Lo mejor para organizaciones que ya usan infraestructura de OAuth.

Dashboard de Mintlify: Úsalo cuando quienes editan la documentación también sean quienes la consultan. Perfecto para equipos internos que ya gestionan contenido a través del dashboard de Mintlify.

Contraseña: Úsalo para un control de acceso sencillo cuando no necesites rastrear usuarios individuales ni personalizar el contenido. Adecuado para contratistas, usuarios beta o escenarios de acceso temporal.

Sesión compartida: Úsalo cuando quieras un inicio de sesión sin fricciones entre tu aplicación y la documentación. Ideal cuando los usuarios ya están autenticados en tu aplicación principal y quieres personalizar su experiencia en la documentación.

Personalización del contenido

Los tres enfoques admiten funciones de personalización del contenido, como contenido MDX dinámico, el rellenado previo de la API key y controles de visibilidad de páginas. Para obtener instrucciones de implementación detalladas, consulta Configuración de personalización.