Benutzer und Benutzergruppen
Benutzer verfügen über URIs des Formulars: /user/{id} oder /user/{name}, wobei {id} die interne eindeutige Benutzer-ID/-Nummer und {name} der eindeutige Benutzername ist.
Es gibt auch die speziellen URI /user/self, der es ermöglicht, auf den in der Anfragskopfzeile Authorization übergebenen Benutzer zu verweisen.
Benutzergruppen verfügen über URIs des Formulars: /user/group/{id} oder /user/group/{name}, wobei {id} die interne eindeutige Gruppe-ID/-Nummer und {name} der eindeutige Gruppenname ist.
Bitte beachten Sie: Der Benutzer- oder Gruppenname kann geändert werden, sodass es keine Garantie gibt, dass auf dem Namen basierende URIs immer dieselbe/identische Ressource identifizieren, wohingegen URIs auf der unveränderlichen ID basieren.
Benutzerschema abrufen
Einen neuen Benutzer erstellen
POST /user
Der Anfragetext muss ein gültiges Benutzerobjekt mit allen erforderlichen Eigenschaften enthalten.
Vorhandenen Benutzer aktualisieren
PUT /user
Der Anfragetext muss ein Benutzerobjekt mit "uri" und den zu aktualisierenden Eigenschaften enthalten.
Informationen zu einem vorhandenen Benutzer abrufen
Liste der Benutzer abrufen
GET /users/page/{page}[?query]
Gibt die angegebene Seite aller Benutzer zurück (entspricht dem angegebenen Filter).
Parameter | Typ | Erforderlich | Bedeutung |
|---|
page | Ganzzahl | Ja | Anzahl der zurückzugebenden Ergebnisseiten. Die erste Seite hat die Nummer 1. |
pagesize | Ganzzahl | Nein | Die Seitengröße als Anzahl der Einträge. Der gültige Bereich ist [1 .. 500]. Der Standardwert ist 100. |
filter | Zeichenfolge | Nein | Falls vorhanden: Gibt nur Benutzer zurück, deren Daten diese Zeichenfolge enthalten. |
Beispiel:
GET https://hostname/cb/rest/users/page/1?pagesize=50&filter=Intland
Benutzerlizenz-Schema abrufen
Verfügbare Benutzerlizenzen abrufen
GET /user/licenses
Dabei handelt es sich um die auf dem System installierten Lizenzen. Sie können keine Codebeamer Lizenz über die REST-API installieren, nur zugeordnete Benutzer mit Lizenzen.
Die Lizenzen abrufen, die einem bestimmten Benutzer zugewiesen sind
Die Lizenzen festlegen, die einem bestimmten Benutzer zugewiesen sind
PUT {userURI}/licenses
Z.B.:
{
"ALM": "USER_WITH_FLOATING_LICENSE",
"RM": "USER_WITH_NAMED_LICENSE
}
Benutzerberechtigungsschema abrufen
GET /user/permission/schema
Alle verfügbaren Benutzerberechtigungen abrufen
GET /user/permissions
Sie können Benutzerberechtigungen nicht erstellen, aktualisieren oder löschen und nur den Benutzergruppen die Berechtigungen zuweisen.
Berechtigungen eines bestimmten Benutzers abrufen
GET {userURI}/permissions
Sie können Benutzern nicht direkt Berechtigungen zuweisen. Sie können nur den Benutzergruppen die Berechtigungen zuweisen und dann Benutzer zu Gruppenmitgliedern machen.
Benutzergruppenschema abrufen
Definierte Benutzergruppen abrufen
Neue Benutzergruppe erstellen
POST /user/group
Der Anfragetext muss ein gültiges Benutzergruppen-Objekt mit allen erforderlichen Eigenschaften enthalten, z.B.:
{
"name": "REST API Users",
"description": "All users that are allowed to use the REST API",
"permissions": [
"Own Account - Admin",
"Account - View Address"
]
}
Sie können Berechtigungen als vollständige Berechtigungsobjekte per Berechtigungsname (siehe oben) oder sogar als einfacher per Berechtigungs-ID übergeben, z.B.
"permissions" : [2, 8]
Vorhandene Benutzergruppe aktualisieren
PUT /user/group/{userGroupId}
Der Anfragetext muss die zu aktualisierenden Eigenschaften enthalten, z.B.:
{
"name": "My User Group edited"
}
Benutzergruppe löschen
Informationen zu einer Benutzergruppe abrufen
Gruppenänderungshistorie abrufen
Alle aktuellen Mitglieder einer Benutzergruppe abrufen
Mitglieder einer Benutzergruppe festlegen
PUT {groupURI}/members
Der Anfragetext muss ein Array von Benutzerobjekten enthalten, die die exklusiven Mitglieder dieser Gruppe sein sollten (Benutzer-URIs sind ausreichend). Z.B.:
[ "/user/bond", "/user/TestUser" ]
Historie-Schema der Gruppenmitglieder abrufen
GET /user/group/members/history/schema
Mitgliedshistorie einer Benutzergruppe abrufen
GET {groupURI}/members/history
Gruppen abrufen, in denen ein bestimmter Benutzer derzeit Mitglied ist
Gruppenmitgliedschaftshistorie eines bestimmten Benutzers abrufen
GET {userURI}/groups/history
Gruppen festlegen, in denen ein bestimmter Benutzer Mitglied ist
PUT {userURI}/groups
Der Anfragetext muss ein Array von Benutzergruppen enthalten (nur Gruppen-URI ist ausreichend), z.B.:
[ "/user/group/1001", "/user/group/External" ]
Einen Benutzer zu Mitglied einer Gruppe machen
PUT {userURI}{groupURI}
PUT {groupURI}{userURI}
Der Anfragetext ist optional und kann eine einzelne Kommentarzeichenfolge enthalten. Z.B.:
"Why it was necessary to add this user to this group"
Benutzer aus einer Gruppe entfernen
DELETE {userURI}{groupURI}
DELETE {groupURI}{userURI}
Der Anfragetext ist optional und kann eine einzelne Kommentarzeichenfolge enthalten. Z.B.:
"It was necessary to remove this user from this group, because ..."
Die Mitgliedschaftshistorie eines bestimmten Benutzers für eine bestimmte Gruppe abrufen
GET {userURI}{groupURI}/history
GET {groupURI}{userURI}/history
Foto eines bestimmten Benutzers abrufen
GET {userURI}/photo
Vorsicht!
Diese Anforderung gibt keinen JSON-Text zurück, sondern die JPEG-Benutzer-Bilddaten Content-type: image/jpeg.
Foto eines bestimmten Benutzers einstellen
PUT {userURI}/photo
Vorsicht!
Der Anfragetext darf keine JSON, sondern die Bilddaten Content-type: image/* enthalten.
Foto eines bestimmten Benutzers entfernen