Configuración de autenticación

Controla el acceso a tu documentación mediante la autenticación de usuarios.

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

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

La autenticación exige 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.

​

Configurar la autenticación

Selecciona el método de handshake que quieres configurar.

Contraseña

La Autenticación con contraseña solo proporciona control de acceso y no admite la personalización de contenido.

​

Requisitos previos

• Tus políticas 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. Ingresa 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 control de acceso básico sin rastrear 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 uses 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.

​

Páginas individuales

Para hacer pública una página, agrega public: true al frontmatter de la página.

Public page example

---
title: "Página pública"
public: true
---

​

Grupos de páginas

Para hacer públicas todas las páginas de un grupo, añade "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"
        ]
      }
    ]
  }
}

​

Controla el acceso con groups

Cuando usas OAuth o autenticación con JWT (JSON Web Token), puedes restringir páginas específicas a ciertos grupos de usuarios. Esto es útil cuando quieres que distintos usuarios vean contenido diferente según su rol o atributos.

Los grupos se gestionan mediante los datos del usuario enviados durante la autenticación.

Example user info

{
  "groups": ["admin", "beta-users"],
  "content": {
    "firstName": "Jane",
    "lastName": "Doe"
  }
}

Especifica qué groups pueden acceder a páginas determinadas usando la propiedad groups en el frontmatter.

Example page restricted to the admin group

---
title: "Panel de administración"
groups: ["admin"]
---

Los usuarios deben pertenecer al menos a uno de los groups enumerados para acceder a la página. Si un usuario intenta acceder a una página sin el group requerido, recibirá un error 404.

​

Interacción con los modos de autenticación

groups funcionan de manera diferente según tu modo de Autenticación.

Autenticación completa con groups:

• Todas las páginas requieren Autenticación.
• Las páginas sin la propiedad groups son accesibles para todos los usuarios autenticados.
• Las páginas con la propiedad groups solo son accesibles para usuarios autenticados que pertenezcan a esos groups.

Autenticación parcial con groups:

• Las páginas requieren Autenticación a menos que las hagas públicas.
• Las páginas con public: true y sin groups son accesibles para todos.
• Las páginas con groups (con o sin public: true) solo son accesibles para usuarios autenticados que pertenezcan a esos groups.

Anyone can view this page

---
title: "Guía pública"
public: true
---

Only authenticated users can view this page

---
title: "Referencia de API"
---

```mdx Solo los usuarios autenticados en los grupos pro o enterprise pueden ver esta página
---
title: "Configuraciones avanzadas"
groups: ["pro", "enterprise"]
---