La autenticación privada para tu organización de Mintlify está disponible en todos los planes.La autenticación por contraseña requiere un plan Pro o Enterprise.La autenticación con OAuth y JWT requiere un plan Enterprise.
docs.ejemplo.com o ejemplo.mintlify.site. La autenticación no es compatible para sitios con una subruta personalizada. Por ejemplo, ejemplo.com/docs.
Cuando activas la autenticación, puedes eliminar las implementaciones de vista previa existentes que, de lo contrario, seguirían siendo de acceso público. Consulta Vistas previas existentes al activar la autenticación.
Para identificar a los visitantes sin dejar de mantener las páginas públicas, usa la personalización. La personalización admite subrutas personalizadas y puede rellenar previamente los campos del área de pruebas de la API sin exigir a los visitantes que se autentiquen antes de ver una página.
Elige un método de autenticación
Configurar la autenticación
- Contraseña
- Autenticación privada
- OAuth 2.0
- JWT
La autenticación mediante contraseña proporciona únicamente control de acceso y no admite funciones específicas por usuario, como el control de acceso basado en grupos o el autocompletado previo del área de pruebas de la API.
Requisitos previos de la contraseña
- Tus requisitos de seguridad permiten compartir contraseñas entre usuarios.
Configuración de la contraseña
1
Crea una contraseña.
- En tu dashboard, ve a Access.
- Establece Visibility en Private.
- Establece Method en Password.
- Introduce una contraseña segura.
- Haz clic en Save.
2
Distribuye el acceso.
Comparte de forma segura la contraseña y la URL de la documentación con los usuarios autorizados.
Ejemplo de contraseña
docs.foo.com y necesitas un control de acceso básico sin hacer seguimiento de usuarios individuales. Quieres evitar el acceso público sin complicar la configuración.Crea una contraseña segura en tu dashboard. Comparte las credenciales con los usuarios autorizados.Hacer públicas las páginas
public.
Páginas individuales
public: true al frontmatter de la página.
Public page example
Grupos de páginas
"public": true debajo del nombre del grupo en el objeto navigation de tu docs.json.
Public group example
Controla el acceso con groups
Example user info
groups en el frontmatter.
Example page restricted to the admin group
groups a nivel de página para el contenido sensible.
Cómo interactúan los groups con las páginas públicas
- Todas las páginas requieren Autenticación de forma predeterminada.
- Las páginas con una propiedad
groupssolo son accesibles para usuarios autenticados dentro de esos groups. - Las páginas sin la propiedad
groupsson accesibles para todos los usuarios autenticados. - Las páginas con
public: truey sin la propiedadgroupsson accesibles para cualquier persona.
Formato de datos de usuario
string
Obligatorio para la autenticación JWT. El nombre de host de tu sitio de documentación. La cadena debe coincidir exactamente con el dominio donde implementas tu documentación. Mintlify valida que el host del JWT coincida con el host de la solicitud para evitar la reutilización de tokens entre diferentes sitios.
number
Momento de expiración de la sesión en segundos desde el epoch. Cuando la hora actual supera este valor, Mintlify expira los datos de usuario almacenados. El visitante debe autenticarse de nuevo o repetir el flujo de identificación para actualizarlos.
string[]
Lista de los grupos a los que pertenece el usuario. Con autenticación, las páginas cuyo frontmatter tenga un
groups coincidente son accesibles para este usuario. Con la personalización independiente, groups controla la visibilidad de páginas y contenido, pero no restringe el acceso a la URL directa de una página.Ejemplo: Un usuario con groups: ["admin", "engineering"] coincide con el contenido etiquetado con los grupos admin o engineering.Record<string, any>
Datos personalizados accesibles en páginas MDX mediante la variable
user para contenido personalizado.object
Rellena previamente los campos del área de pruebas de la API con valores específicos del usuario. Cuando un usuario se autentica, estos valores rellenan los campos de entrada correspondientes en el área de pruebas de la API. Los usuarios pueden sobrescribir los valores rellenados previamente, y sus cambios persisten en el almacenamiento local.Mintlify aplica únicamente los valores que coinciden con el esquema de seguridad del endpoint actual.
Disponibilidad de funciones
llms.txt, llms-full.txt y skill.md, están sujetos a los mismos requisitos de autenticación que las páginas de tu documentación.