Authentication

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

Enabling Authentication

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

The page’s authentication method will override mint.json if both are set.

Bearer Token

mint.json

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

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

Basic Authentication

mint.json

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

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

API Key

mint.json

"api": {
    "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 mint.json.

Page Metadata

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