Saltar al contenido principal
Los planes Pro incluyen autenticación por contraseña.Los planes Enterprise incluyen todos los métodos de autenticación.
La autenticación requiere que los usuarios inicien sesión antes de acceder a tu documentación.

​
Modos de autenticación

Elige entre autenticación completa o parcial según tus necesidades de control de acceso. Autenticación completa: Todas las páginas están protegidas. Los usuarios deben iniciar sesión antes de acceder a cualquier contenido. Autenticación parcial: Algunas páginas son públicas, mientras que otras requieren autenticación. Los usuarios pueden explorar libremente el contenido público y autenticarse solo al acceder a páginas protegidas. Al configurar cualquiera de los métodos de autenticación a continuación, deberás seleccionar Autenticación completa o Autenticación parcial en la configuración del panel.

​
Configuración de la autenticación

Selecciona el método de handshake que quieres configurar.
  • Contraseña
  • Panel de Mintlify
  • OAuth 2.0
  • JWT
La autenticación con contraseña ofrece únicamente control de acceso y no admite la personalización de contenido.

​
Requisitos previos

  • Tus requisitos de seguridad permiten compartir contraseñas entre usuarios.

​
Implementación

1

Crea una contraseña.

  1. En tu panel, ve a Authentication.
  2. Selecciona Full Authentication o Partial Authentication.
  3. Selecciona Password.
  4. Introduce una contraseña segura.
  5. Selecciona Save changes.
2

Distribuye el acceso.

Comparte de forma segura la contraseña y la URL de la documentación con los usuarios autorizados.

​
Ejemplo

Tu documentación está alojada en docs.foo.com y necesitas un control de acceso básico sin rastrear a usuarios individuales. Quieres evitar el acceso público manteniendo una configuración simple.Crea una contraseña segura en tu panel. Comparte las credenciales con los usuarios autorizados. ¡Listo!

​
Hacer que las páginas sean públicas

Al usar la autenticación parcial, todas las páginas están protegidas de forma predeterminada. Puedes hacer que páginas específicas sean visibles sin autenticación, a nivel de página o de grupo, con la propiedad public.

​
Nivel de página

Para hacer pública una página, agrega public: true al frontmatter de la página.
Ejemplo de página pública
---
title: "Página pública"
public: true
---

​
Nivel de grupo

Para que todas las páginas de un grupo sean públicas, agrega "public": true debajo del nombre del grupo en el objeto navigation de tu docs.json.
Ejemplo de grupo público
{
  "navigation": {
    "groups": [
      {
        "group": "Grupo público",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Grupo privado",
        "icon": "pause",
        "pages": [
          "informacion-privada",
          "ajustes-secretos"
        ]
      }
    ]
  }
}