L’API ClearPolicy utilise des jetons porteurs pour l’authentification. Chaque requête doit inclure un jeton API valide dans l’en-têteDocumentation Index
Fetch the complete documentation index at: https://docs.clearpolicy.app/llms.txt
Use this file to discover all available pages before exploring further.
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.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é.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.
Passer le jeton dans les requêtes
Incluez le jeton dans l’en-têteAuthorization de chaque requête API :
Réponses d’erreur
| Statut | Signification |
|---|---|
401 Unauthorized | Le jeton est manquant, expiré ou invalide. |
403 Forbidden | Le 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.