Authentifizierung
Wie Everyn-API-Clients sich authentifizieren, Organisationen auswählen und Scopes verwenden.
Everyn-Produkt-API-Aufrufe nutzen organisationsgebundene API Keys. Ein Maschinen-Key wählt genau eine Organisation aus, deshalb leiten Produktrouten den Tenant-Kontext aus dem Bearer Credential ab und vertrauen keinen vom Client gesetzten Organisations-IDs.
Authentifizierungsmodell
Nutze den Standard-Bearer-Header für Maschinen-/API-Key-Aufrufe:
Authorization: Bearer sk-everyn-...Produkt-API-Keys sind Maschinen-Principals. Sie können Produktbereiche wie Datasets, Job Specs, Runs, Exports, Alert Rules und Webhooks aufrufen, aber keine Organisationen, Mitglieder, Einladungen, Audit Events oder API Keys verwalten.
Implementierte Maschinen-Key-Scopes:
| Scope | Verwendung |
|---|---|
datasets:read / datasets:write | Dataset-Reads und Dataset-Upload-Intake. |
job_specs:read / job_specs:write | Model-Catalog-Reads und Job-Spec-Verwaltung. |
runs:read / runs:write | Run-Erstellung, Start, Cancel, Retry, Inspektion, Rows, Outputs und Failures. |
exports:read / exports:write | Export-Erstellung, Polling, Listing und Download. |
alert_rules:read / alert_rules:write | Alert Rules und Alert-Delivery-Inspektion. |
webhooks:read / webhooks:write | Webhook Endpoints, Secret Rotation, Tests und Delivery-Inspektion. |
Häufige Auth-Ergebnisse:
| Status | Bedeutung | Nächster Schritt |
|---|---|---|
401 authentication_failed | Fehlendes, fehlerhaftes, unbekanntes, widerrufenes oder abgelaufenes Credential. | Bearer Credential ersetzen. |
403 authorization_failed | Credential ist gültig, aber Scope oder Rolle fehlt. | Credential mit erforderlichem Scope oder Admin-Rolle nutzen. |
404 not_found | Ressource existiert nicht für die authentifizierte Organisation. | Prüfen, ob die ID zur selben Organisation gehört. |
Nutze API-Fehler für Recovery-Muster und die generierte Referenz für Endpoint-spezifische Auth-Anforderungen.