API-Schlüssel und Scopes

Ein API-Schlüssel erlaubt einem Skript oder einem anderen System, die xEvolve-API ohne Konsolen-Anmeldung aufzurufen. Jeder Schlüssel trägt Scopes, die begrenzen, was er darf.

Einen Schlüssel erstellen

Öffnen Sie „API-Schlüssel“ und wählen Sie „Neuer Schlüssel“.
Geben Sie einen Namen ein, haken Sie die benötigten Scopes an und legen Sie optional ein Ablaufdatum in Tagen fest.
Kopieren Sie den Schlüssel. Er beginnt mit xev_ und wird nur einmal angezeigt. xEvolve speichert nur einen Hash.

Senden Sie den Schlüssel als Bearer-Token an Ihren Workspace:

curl https://<workspace>.xevolve.io/api/v1/connections \
  -H "Authorization: Bearer xev_<key>"

Das Widerrufen eines Schlüssels wirkt sofort. Erstellen und Widerrufen werden im Audit-Protokoll festgehalten.

Regeln

Ein Schlüssel kann nur Schlüssel mit Scopes erstellen, die er selbst besitzt. Wer mehr verlangt, erhält 403.
Ein Aufruf ohne den nötigen Scope antwortet mit 403 und API key missing required scope.
Eine Konsolensitzung ist nicht durch Scopes begrenzt; sie folgt der Rolle des Benutzers.
Einstellungen zur Mehrfaktor-Authentifizierung, Sitzungsverwaltung, Anmeldeereignisse, Registrierung von Service Principals, Avatare, Aufbewahrungsrichtlinie und Teststatus akzeptieren nur Konsolensitzungen. API-Schlüssel erhalten 403.

Scopes

Scope	Erlaubt
`files:read`	Dateien auflisten, durchsuchen und herunterladen.
`files:write`	Dateien hochladen.
`transfers:read`	Übertragungen auflisten und ansehen.
`transfers:write`	Übertragungen erstellen, ausführen und abbrechen.
`connections:read`	Verbindungen auflisten und ansehen.
`connections:write`	Verbindungen erstellen, ändern, löschen und testen.
`data-rooms:read`	Datenräume auflisten und ansehen.
`data-rooms:write`	Datenräume erstellen, ändern und verwalten.
`schedules:read`	Zeitpläne und Laufverlauf auflisten.
`schedules:write`	Zeitpläne erstellen, ändern, löschen und ausführen.
`watchers:read`	Ordnerüberwachungen auflisten.
`watchers:write`	Überwachungen erstellen, ändern und löschen.
`workflows:read`	Workflows und Laufverlauf auflisten.
`workflows:write`	Workflows erstellen, ändern, löschen und ausführen.
`parameters:read`	Globale Parameter auflisten und ansehen.
`parameters:write`	Globale Parameter erstellen, ändern und löschen.
`users:read`	Benutzer auflisten und ansehen.
`users:write`	Benutzer ändern und löschen.
`agents:read`	Verwaltete Agents auflisten und ansehen.
`agents:write`	Verwaltete Agents erstellen, ändern, löschen und testen.
`webhooks:read`	Webhooks und Zustellungen auflisten.
`webhooks:write`	Webhooks erstellen, ändern und löschen.
`activity:read`	Das Aktivitätsprotokoll und die Dashboard-Zähler lesen.
`notifications:read`	Benachrichtigungseinstellungen und das Benachrichtigungsprotokoll lesen.
`notifications:write`	Benachrichtigungseinstellungen ändern oder testen.
`api-keys:read`	API-Schlüssel auflisten.
`api-keys:write`	API-Schlüssel erstellen und widerrufen, innerhalb der Scopes des aufrufenden Schlüssels.

API-Schlüssel und Webhooks erfordern den Tarif Team oder höher. „Tarife und Limits“ nennt die erlaubten API-Anfragen pro Monat.