Zum Hauptinhalt springen
POST
Umfang erstellen

Scope erstellen

POST /v1/scopes Erstellt einen benutzerdefinierten Berechtigungsumfang für den authentifizierten Mandanten. Benutzerdefinierte Umfänge erweitern das integrierte Umfangsregister um mandantenspezifische Berechtigungen. Die Umfangszeichenfolge wird automatisch aus den Feldern resource und action im Format resource:action zusammengesetzt. Benutzerdefinierte Scopes werden anhand der MAIP-Scope-Formatregeln validiert: nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und Sternchen.
Benutzerdefinierte Bereiche sind mandantenisoliert. Sie erscheinen nicht in den Bereichslisten anderer Mandanten. Registrierungen. Eingebaute Plattform-Scopes können nicht überschrieben oder dupliziert werden.

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

string
UUID der neu erstellten Scope-Definition.
string
UUID des besitzenden Mandanten.
string
Die zusammengesetzte Scope-Zeichenfolge im Format resource:action.
string
Die Ressourcenkomponente.
string
Die Aktionskomponente.
string
Menschenlesbarer Bereichsname.
string
Bereichsbeschreibung.
string
Bereichskategorie.
boolean
Immer false für vom Mandanten erstellte Scopes.
string
ISO 8601 Erstellungszeitstempel.

Beispiel


Zuweisen benutzerdefinierter Bereiche zu Agenten

Nachdem Sie einen benutzerdefinierten Bereich erstellt haben, weisen Sie ihn Agenten während der Registrierung oder über die Delegation zu:

Autorisierungen

X-API-Key
string
header
erforderlich

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

Body

application/json
action
string
erforderlich

Aktionskomponente des Bereichs (z. B. „lesen“, „genehmigen“, „*“)

resource
string
erforderlich

Ressourcenkomponente des Umfangs (z. B. „crm“, „payment“)

category
string

Organisatorische Kategorie (Standard ist „custom“)

description
string

Detaillierte Beschreibung dessen, was der Geltungsbereich gewährt

display_name
string

Menschenlesbarer Name für den Bereich

Antwort

Bereich erstellt

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