API-sleutels en scopes

Met een API-sleutel kan een script of ander systeem de xEvolve-API aanroepen zonder in te loggen op de console. Elke sleutel heeft scopes die beperken wat hij mag doen.

Een sleutel maken

Open API-sleutels en kies Nieuwe sleutel.
Voer een naam in, vink de benodigde scopes aan en stel eventueel een verloopdatum in dagen in.
Kopieer de sleutel. Die begint met xev_ en wordt maar één keer getoond. xEvolve bewaart alleen een hash.

Stuur de sleutel als bearer-token naar uw werkruimte:

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

Een sleutel intrekken werkt direct. Het maken en intrekken van sleutels wordt in het auditlogboek vastgelegd.

Regels

Een sleutel kan alleen sleutels maken met scopes die hij zelf heeft. Meer vragen geeft 403.
Een aanroep zonder de vereiste scope geeft 403 met API key missing required scope.
Een consolesessie wordt niet door scopes beperkt; die volgt de rol van de gebruiker.
Instellingen voor meervoudige verificatie, sessiebeheer, aanmeldgebeurtenissen, registratie van service principals, avatars, het bewaarbeleid en de status van de proefperiode accepteren alleen consolesessies. API-sleutels krijgen 403.

Scopes

Scope	Staat toe
`files:read`	Bestanden weergeven, doorzoeken en downloaden.
`files:write`	Bestanden uploaden.
`transfers:read`	Overdrachten weergeven en bekijken.
`transfers:write`	Overdrachten maken, uitvoeren en annuleren.
`connections:read`	Verbindingen weergeven en bekijken.
`connections:write`	Verbindingen maken, bewerken, verwijderen en testen.
`data-rooms:read`	Dataruimtes weergeven en bekijken.
`data-rooms:write`	Dataruimtes maken, bewerken en beheren.
`schedules:read`	Schema's en de uitvoeringsgeschiedenis weergeven.
`schedules:write`	Schema's maken, bewerken, verwijderen en uitvoeren.
`watchers:read`	Mapbewakingen weergeven.
`watchers:write`	Bewakingen maken, bewerken en verwijderen.
`workflows:read`	Workflows en de uitvoeringsgeschiedenis weergeven.
`workflows:write`	Workflows maken, bewerken, verwijderen en uitvoeren.
`parameters:read`	Globale parameters weergeven en bekijken.
`parameters:write`	Globale parameters maken, bewerken en verwijderen.
`users:read`	Gebruikers weergeven en bekijken.
`users:write`	Gebruikers bewerken en verwijderen.
`agents:read`	Beheerde agents weergeven en bekijken.
`agents:write`	Beheerde agents maken, bewerken, verwijderen en testen.
`webhooks:read`	Webhooks en leveringen weergeven.
`webhooks:write`	Webhooks maken, bewerken en verwijderen.
`activity:read`	Het activiteitenlogboek en de dashboardtellers lezen.
`notifications:read`	Meldingsinstellingen en het meldingslogboek lezen.
`notifications:write`	Meldingsinstellingen bewerken of testen.
`api-keys:read`	API-sleutels weergeven.
`api-keys:write`	API-sleutels maken en intrekken, binnen de scopes die de aanroepende sleutel heeft.

API-sleutels en webhooks vereisen het abonnement Team of hoger. Abonnementen en limieten toont de toegestane API-verzoeken per maand.