Saltar al contenido principal
Los planes Pro incluyen la autenticación con 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 los modos de 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 navegar el contenido público libremente y autenticarse solo al acceder a páginas protegidas. Al configurar cualquiera de los métodos de handshake a continuación, seleccionarás Autenticación completa o Autenticación parcial en la configuración de tu dashboard.

Configuración de la autenticación

Selecciona el método de handshake que quieres configurar.
  • Contraseña
  • Dashboard de Mintlify
  • OAuth 2.0
  • JWT (JSON Web Token)
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 dashboard, ve a Autenticación.
  2. Selecciona Autenticación completa o Autenticación parcial.
  3. Selecciona Contraseña.
  4. Introduce una contraseña segura.
  5. Selecciona Guardar cambios.
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 registrar a usuarios individuales. Quieres impedir el acceso público manteniendo una configuración sencilla.Crea una contraseña segura en tu dashboard. Comparte las credenciales con los usuarios autorizados. ¡Listo!

Hacer públicas las páginas

Cuando usas autenticación parcial, todas las páginas están protegidas de forma predeterminada. Puedes permitir que páginas específicas sean accesibles sin autenticación, ya sea a nivel de página o de grupo, con la propiedad public.

A nivel de página

Para hacer que una página sea pública, añade public: true al frontmatter de la página.
Public page example
---
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.
Public group example
{
  "navigation": {
    "groups": [
      {
        "group": "Grupo público",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "Grupo privado",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}
I