Authentication

You can set authentication parameters to let users use their real API keys.

Enabling authentication

You can add an authentication method to your docs.json to enable it globally on every page or you can set it on a per-page basis.

A page’s authentication method will override a global method if both are set.

Bearer token

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "bearer"
      }
    }
}

---
title: "Your page title"
authMethod: "bearer"
---

Basic authentication

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "basic"
      }
    }
}

---
title: "Your page title"
authMethod: "basic"
---

API key

docs.json

"api": {
    "mdx": {
      "auth": {
        "method": "key",
        "name": "x-api-key"
      }
    }
}

---
title: "Your page title"
authMethod: "key"
---

None

The “none” authentication method is useful to disable authentication on a specific endpoint after setting a default in docs.json.

Page Metadata

---
title: "Your page title"
authMethod: "none"
---