Authentification

Vous pouvez configurer des paramètres d’authentification pour permettre aux utilisateurs d’utiliser leurs propres clés d’API réelles.

​

Activation de l’authentification

Vous pouvez ajouter une méthode d’authentification à votre docs.json pour l’activer globalement sur chaque page, ou la définir au cas par cas.

La méthode d’authentification d’une page remplace la méthode globale si les deux sont définies.

​

Jeton Bearer

docs.json

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

​

Authentification Basic

docs.json

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

​

Clé d’API

docs.json

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

​

Aucune

La méthode d’authentification « none » est utile pour désactiver l’authentification sur un endpoint spécifique après avoir défini une valeur par défaut dans docs.json.

Page Metadata

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