Nutzer
Nutzer innerhalb deiner Organisation auflisten, einladen und verwalten.
Nutzer repräsentieren die Personen in deiner Organisation. Du kannst neue Mitglieder einladen, ihre Profile aktualisieren und ihre Rollen verwalten.
Nutzer auflisten
GET /api/v1/usersBerechtigung erforderlich: members:view
Gibt alle Nutzer der Organisation zurück.
Beispiel-Response
[
{
"id": "usr_abc123",
"email": "[email protected]",
"name": "Alex Smith",
"role": "ADMIN",
"createdAt": "2025-01-15T10:00:00Z"
},
{
"id": "usr_def456",
"email": "[email protected]",
"name": "Jamie Lee",
"role": "TEAM_MEMBER",
"createdAt": "2025-02-01T09:00:00Z"
}
]Nutzer erstellen (einladen)
POST /api/v1/usersBerechtigung erforderlich: members:invite
Lade einen neuen Nutzer in die Organisation ein. Er erhält eine E-Mail mit Anmeldedaten.
Request Body
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| string | Ja | E-Mail-Adresse des Nutzers | |
| name | string | Ja | Vollständiger Name des Nutzers |
| role | string | Ja | ADMIN, TEAM_MEMBER oder CUSTOMER |
| password | string | Ja | Initiales Passwort (mind. 8 Zeichen, muss Groß-, Kleinbuchstaben, Zahl und Sonderzeichen enthalten) |
Beispiel-Request
{
"email": "[email protected]",
"name": "Jamie Lee",
"role": "TEAM_MEMBER",
"password": "SecureP@ss123"
}Nutzer abrufen
GET /api/v1/users/{userId}Berechtigung erforderlich: members:view
Gibt Details zu einem bestimmten Nutzer zurück.
Nutzer aktualisieren
PATCH /api/v1/users/{userId}Berechtigung erforderlich: members:edit
Request Body
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| name | string | Nein | Name des Nutzers |
| role | string | Nein | ADMIN, TEAM_MEMBER oder CUSTOMER |
Nutzerrolle aktualisieren
PATCH /api/v1/users/{userId}/roleBerechtigung erforderlich: members:edit
Ändert die Organisationsrolle eines Nutzers.
Request Body
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| role | string | Ja | ADMIN, TEAM_MEMBER oder CUSTOMER |