Die ClearPolicy-API verwendet Bearer-Tokens zur Authentifizierung. Jede Anfrage muss einen gültigen API-Token imDocumentation 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-Header enthalten. Tokens sind an die Organisation gebunden, in der sie erstellt wurden. Der verwendete Token bestimmt daher, welche Organisationsdaten zurückgegeben werden.
Einen API-Token erstellen
Eigentümer und Administratoren der Organisation können API-Tokens in ClearPolicy erstellen.Einen Token erstellen
Klicke auf API-Token erstellen. Gib dem Token einen klaren Namen, zum Beispiel
Berichtsautomatisierung, damit dein Team weiß, wofür er verwendet wird.Den Bearer-Token kopieren
Kopiere den Token, wenn ClearPolicy ihn anzeigt. Nachdem du den Dialog geschlossen hast, kannst du den vollständigen Token nicht erneut anzeigen.
Das Token in Anfragen übergeben
Füge das Token in denAuthorization-Header jeder API-Anfrage ein:
Fehlerantworten
| Status | Bedeutung |
|---|---|
401 Unauthorized | Das Token fehlt, ist abgelaufen oder ungültig. |
403 Forbidden | Das Token ist gültig, hat aber keine Berechtigung für die angeforderte Ressource. |
Tokens sind organisationsspezifisch. Alle API-Antworten spiegeln die Organisation wider, in der das Token erstellt wurde.
Der API-Zugriff richtet sich außerdem nach der Rolle des Teammitglieds in ClearPolicy. Eigentümer und Administratoren können API-Tokens erstellen und verwalten. Tokens, die an Gruppenleitende gebunden sind, können den Token mit
GET /me bestätigen, aber Endpunkte für Personen, Dokumente und Bestätigungsanfragen geben 403 Forbidden zurück.