Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.clearpolicy.app/llms.txt

Use this file to discover all available pages before exploring further.

L’API ClearPolicy utilise des jetons porteurs pour l’authentification. Chaque requête doit inclure un jeton API valide dans l’en-tête Authorization. Les jetons sont liés à l’organisation où ils ont été créés. Le jeton utilisé détermine donc les données d’organisation renvoyées.

Créer un jeton API

Les propriétaires et administrateurs d’organisation peuvent créer des jetons API dans ClearPolicy.
1

Ouvrez les paramètres de l'API

Dans le tableau de bord ClearPolicy, allez dans Paramètres -> API.
2

Créez un jeton

Cliquez sur Créer un token API. Donnez au jeton un nom clair, comme Automatisation des rapports, afin que votre équipe sache où il est utilisé.
3

Copiez le jeton porteur

Copiez le jeton lorsque ClearPolicy l’affiche. Vous ne pourrez plus voir le jeton complet après avoir fermé la fenêtre.
4

Conservez-le en lieu sûr

Enregistrez le jeton dans votre gestionnaire de mots de passe, votre gestionnaire de secrets ou les paramètres de votre intégration. Ne le partagez pas par e-mail, chat ou code public.

Passer le jeton dans les requêtes

Incluez le jeton dans l’en-tête Authorization de chaque requête API :
Authorization: Bearer YOUR_ACCESS_TOKEN
Exemple de requête utilisant le jeton :
curl https://api.clearpolicy.app/api/v1/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Réponses d’erreur

StatutSignification
401 UnauthorizedLe jeton est manquant, expiré ou invalide.
403 ForbiddenLe jeton est valide, mais il n’a pas l’autorisation pour la ressource demandée.
Les jetons sont liés à une organisation. Toutes les réponses de l’API reflètent l’organisation où le jeton a été créé.
L’accès à l’API suit également le rôle du membre d’équipe dans ClearPolicy. Les propriétaires et administrateurs peuvent créer et gérer des jetons API. Les jetons liés à un gestionnaire de groupe peuvent confirmer le jeton avec GET /me, mais les points de terminaison des personnes, documents et demandes de validation renvoient 403 Forbidden.

Révoquer un jeton

Allez dans Paramètres -> API pour consulter les jetons API actifs. Vous pouvez voir qui a créé chaque jeton, quand il a été créé, quand il a été utilisé pour la dernière fois et quand il expire. Cliquez sur Révoquer pour supprimer l’accès d’un jeton dont vous n’avez plus besoin.
Last modified on May 27, 2026