Juristische Person

Benutzer

Benutzer abrufen und verwalten, Benutzer klonen und Benutzer archivieren.

Endpunkte

GET/api/v2/usersRuft eine Liste ab

GET/api/v2/users/{id}Ruft einen Datensatz ab

POST/api/v2/usersDatensätze erstellen

PATCH/api/v2/usersDatensätze aktualisieren

Einen Benutzer klonen

POST/api/v2/users/{id}/cloneEinen Benutzer aus einem bestehenden Benutzer erstellen

Senden Sie im Anfragetext ein JSON-Objekt, das nur die Eigenschaften enthält, die sich vom Quellbenutzer unterscheiden sollen. Die Antwort lautet : { data: {created-object} }.

Archivbenutzer

POST/api/v2/users/delete/{id1},{id2},…Archiviert bis zu 50 Benutzer

Die Antwort lautet { success: true, archived: [id1, id2, …], skipped: [] }.

Archiviert einen oder mehrere Benutzer. Nur Administratoren können diesen Endpunkt aufrufen. Aktive Benutzer werden archiviert; bereits archivierte Benutzer werden übersprungen. Es handelt sich um ein vorläufiges Löschen – Benutzer werden nicht endgültig gelöscht und bleiben im Benutzerordner erhalten. Bis zu 50 Benutzer-IDs können als kommagetrennte Liste übergeben werden.

Über p_to_uid kann optional ein Ersatzbenutzer angegeben werden . Dieser muss ein aktiver Benutzer desselben Unternehmens sein. Ein Benutzer kann sich nicht selbst archivieren oder als sein eigener Ersatz ausgewählt werden.

Die Benutzer 1, 2 und 3 sollen archiviert und ihre Arbeit dem Benutzer 6 neu zugewiesen werden:

bash

Beispiel

curl -X POST \ -H 'Authorization: bearer YourTokenHere' \ -H 'Content-Type: application/x-www-form-urlencoded' \ --data 'p_to_uid=6' \ 'https://app.celoxis.com/psa/api/v2/users/delete/1,2,3'

Einen Benutzer archivieren, ohne einen Ersatz anzugeben:

bash

Beispiel

curl -X POST \ -H 'Authorization: bearer YourTokenHere' \ 'https://app.celoxis.com/psa/api/v2/users/delete/1'