Zum Hauptinhalt springen
GET
Scopes auflisten

Scopes auflisten

GET /v1/scopes Gibt alle Berechtigungsbereiche zurück, die dem authentifizierten Mandanten zur Verfügung stehen. Dies umfasst plattformdefinierte integrierte Bereiche und alle vom Mandanten erstellten benutzerdefinierten Bereiche. Bereiche folgen dem resource:action-Format, das durch das MAIP-Protokoll definiert ist.

Authentifizierung

Erfordert X-API-Key Header oder Bearer JWT Token. Der Arbeitsbereich wird aus den authentifizierten Anmeldeinformationen abgeleitet; senden Sie X-Tenant-ID nicht.

Antwort

Gibt ein Array von Bereichsdefinitionsobjekten zurück.
string
UUID der Scope-Definition.
string
UUID des Mandanten, dem dieser Scope gehört. null für plattformweite integrierte Scopes.
string
Die vollständige Scope-Zeichenfolge im Format resource:action (z.B. "data:read", "model:train").
string
Die Ressourcenkomponente des Scopes (z.B. "data", "model", "tool").
string
Die Aktionskomponente des Scopes (z. B. "read", "write", "*").
string
Menschenlesbarer Name für den Geltungsbereich.
string
Detaillierte Beschreibung dessen, worauf der Bereich Zugriff gewährt.
string
Bereichskategorie für organisatorische Zwecke.
boolean
true für plattformdefinierte Bereiche, false für vom Mandanten erstellte benutzerdefinierte Bereiche.
string
ISO 8601 Erstellungszeitstempel.

Beispiel


Eingebaute Bereichskategorien

Die Plattform bietet über 25 integrierte Scopes in 6 Kategorien:

Referenz zum Bereichsformat

Autorisierungen

X-API-Key
string
header
erforderlich

API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung

Abfrageparameter

category
enum<string>

Bereiche nach Kategorie filtern

Verfügbare Optionen:
data,
model,
tool,
agent,
admin,
receipt,
custom

Antwort

Verfügbare Bereiche

id
string<uuid>
tenant_id
string<uuid> | null
scope
string
resource
string
action
string
display_name
string
description
string
category
string
is_builtin
boolean
created_at
string<date-time>