Berechtigungs-Gruppen
2 Endpunkte unter /api/rest/2.0
Account roles (Berechtigungsrollen)
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
Diese Ressource ist nur lesend. Sie liefert die Daten für Auswahl und Anzeige; angelegt und geändert wird in der Oberfläche.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/roles |
List all roles |
GET |
/roles/{id} |
Get a role |
Felder
Diese Felder liefert die API zu Berechtigungs-Gruppen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
name |
string | Role name |
is_default |
boolean | Automatically assigned to new accounts |
is_register |
boolean | Available for self-registration |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.