Authentication setup

Control access to your documentation by authenticating users.

Pro plans include password authentication. Custom plans include all authentication methods.

Require users to log in before accessing your documentation.

Authentication modes

Full authentication: All pages require login.

Partial authentication: Some pages are public, others require login.

Select your mode when configuring any method below.

Configure authentication

Select the handshake method that you want to configure.

Password

Password authentication does not support content personalization.

1. Create a password

   1. Go to Authentication.
   2. Select Full Authentication or Partial Authentication.
   3. Select Password and enter a secure password.
   4. Select Save changes.
2. Share access

   Share the password and documentation URL with authorized users.

Make pages public

With partial authentication, pages are protected by default. Make pages public with the public property.

Individual pages

Add public: true to the page’s frontmatter:

---
title: "Public page"
public: true
---

Groups

Add "public": true to the group in docs.json:

{
  "navigation": {
    "groups": [
      {
        "group": "Public group",
        "public": true,
        "pages": ["quickstart", "installation"]
      }
    ]
  }
}

Control access with groups

With OAuth or JWT authentication, restrict pages to specific user groups. Pass groups in user data during authentication:

User info with groups

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

Restrict pages using the groups property in frontmatter:

---
title: "Admin dashboard"
groups: ["admin"]
---

Users need at least one matching group to access the page. Without a match, they receive a 404 error.

With authentication modes

Full authentication:

• Pages without groups: accessible to all authenticated users
• Pages with groups: accessible only to users in those groups

Partial authentication:

• Pages with public: true and no groups: accessible to everyone
• Pages with groups: accessible only to authenticated users in those groups

Public page

---
title: "Public guide"
public: true
---

Authenticated users only

---
title: "API reference"
---

Specific groups only

---
title: "Advanced configurations"
groups: ["pro", "enterprise"]
---