Rechte
Ein Recht, in der API „Scope“ genannt, hat die Form bereich:aktion. Ein Token oder Bot trägt nur die Rechte, die du ihm gibst.
Alle Rechte
Die Spalte „Mitbenutzer braucht“ nennt das Freigabe-Recht, das ein Mitbenutzer eines Servers haben muss, damit ein Token in seinem Namen den Aufruf ausführen darf. Der Besitzer des Servers vergibt diese Freigaben.
| Recht | Name | Erlaubt | Mitbenutzer braucht |
|---|---|---|---|
| servers:read | Server lesen | Server, Ressourcen und Aktivität lesen: GET /servers, /servers/{id}, …/resources und …/activity. | canViewServer |
| servers:power | Server starten und stoppen | Start, Stopp, Neustart und Beenden: POST /servers/{id}/power. | canManagePower |
| servers:console | Konsolenbefehle senden | Befehle an die Konsole schicken: POST /servers/{id}/commands. | canSendCommands |
| backups:read | Backups lesen | Backups eines Servers auflisten: GET /servers/{id}/backups. | canViewBackups |
| backups:write | Backups anlegen | Ein Backup anlegen: POST /servers/{id}/backups. | canManageBackups |
| git:read | Git-Quellen lesen | Git-Quellen und Deployments lesen: GET …/git/sources und …/git/deployments. | canViewServer |
| git:deploy | Git-Deploy auslösen | Einen Deploy anstoßen: POST …/git/sources/{sourceId}/deploy. | canDeployGit |
| git:manage | Git-Quellen verwalten | Git-Quellen anlegen und ändern. Dieses Recht ist noch nicht vergebbar. | nur der Besitzer |
Welche Rechte wirksam sind
Bei jedem Aufruf gilt nur die Schnittmenge aus drei Dingen:
- den Rechten des Tokens,
- bei einem Bot den Rechten seiner Installation auf dem Server,
- der aktuellen Freigabe des handelnden Users.
Ein Token kann deshalb nie mehr als du. Mehr zu Bots und ihrer Installation steht unter Bots und Manifest.
Wenn ein Recht fehlt
- 403
INSUFFICIENT_SCOPE: Dem Token oder der Installation des Bots fehlt das Recht. Das Feldscopenennt es. Nutze ein Token mit diesem Recht. - 403
FORBIDDEN: Dem handelnden User fehlt die Freigabe auf dem Server. Bitte den Besitzer des Servers um das Freigabe-Recht aus der Tabelle.
Antwort 403 INSUFFICIENT_SCOPE
{
"code": "INSUFFICIENT_SCOPE",
"message": "Dem Token fehlt das Recht servers:power.",
"requestId": "c07e19a4b2d84f6e90a3b5d17c28e46f",
"scope": "servers:power"
}Alle Fehlercodes mit Bedeutung stehen unter Fehler.