Show Menu
THEMEN×

API-Methoden für Benutzerverwaltung

Verwenden Sie keine API Methoden zum Verwalten von Benutzern, einschließlich Erstellen, Aktualisieren, Auflisten, Löschen und Zurückgeben von Benutzerobjekten.

Create a User

Eine POST Methode zum Erstellen eines neuen Benutzers.

Anfrage

POST /api/v1/users/

Stichprobenanforderungskörper

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : true | false 
}

Antwort

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...], 
  "isAdmin" : <"true"|"false"> 
 
}

Wenn "true" isAdmin festgelegt ist, wird der Benutzer als Partner-Administrator erstellt. Diese Eigenschaft informiert Sie auch darüber, ob ein Benutzer ein Partner-Administrator ist.
Gibt zurück, 409 Conflict wenn der Benutzername bereits verwendet wurde.

Benutzer aktualisieren

Eine PUT Methode zum Aktualisieren eines Benutzers.

Anfrage

PUT /api/v1/users/ <userId>

Stichprobenanforderungskörper

{ 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
}

Antwort

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "groups" : [<group_1_id>, ...] 
 
}

Gibt zurück, 409 Conflict wenn der Benutzername bereits verwendet wurde.

Anmeldenamen Benutzer aktualisieren

Eine PUT Methode zum Aktualisieren des derzeit angemeldeten Benutzers.
Während die meisten API Methoden nur von Partneradministratoren aufgerufen werden können, ist diese Methode von Benutzern ohne Administratorrechte aufgerufen werden können.

Anfrage

PUT /self/update

Stichprobenanforderungskörper

{  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

Antwort

{ 
  "userId": <integer>,,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string> 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null> 
}

Gibt zurück, 409 Conflict wenn der Benutzername bereits verwendet wurde.

Kennwort des angemeldeten Benutzers aktualisieren

Eine PUT Methode zum Aktualisieren des derzeit angemeldeten Benutzers.
Während die meisten API Methoden nur von Partneradministratoren aufgerufen werden können, ist diese Methode von Benutzern ohne Administratorrechte aufgerufen werden können.

Anfrage

POST /users/self/update-password

Stichprobenanforderungskörper

{ "oldPassword" : "old password", "newPassword" : "new password" }

Gibt 200 OK bei erfolgreicher Ausführung zurück. Gibt zurück, 400 Bad Request wenn mit einem der beiden Kennwörter etwas nicht stimmt.

Passwort des angemeldeten Benutzers zurücksetzen

Eine PUT Methode zum Zurücksetzen des derzeit angemeldeten Benutzers. Audience Management sendet dem Benutzer ein vom System generiertes Kennwort.
Während die meisten API Methoden nur von Partneradministratoren aufgerufen werden können, ist diese Methode von Benutzern ohne Administratorrechte aufgerufen werden können.

Anfrage

POST /self/reset-password
Gibt 200 OK bei erfolgreicher Ausführung zurück.

Rückgabe eines Benutzerobjekts für eine Benutzer-ID

Eine Get Methode zur Rückgabe des Benutzerobjekts für eine Benutzer-ID.

Anfrage

GET /api/v1/users/ <userId>

Antwort

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

Rückgabebenutzerobjekt für angemeldeten Benutzer

Eine Get Methode zur Rückgabe des Benutzerobjekts für den derzeit angemeldeten Benutzer.
Während die meisten API Methoden nur von Partneradministratoren aufgerufen werden können, ist diese Methode von Benutzern ohne Administratorrechte aufgerufen werden können.

Anfrage

GET /api/v1/users/self

Antwort

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email" : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<groupd_id_1>, ...] 
 
}

Benutzer auflisten

Eine GET Methode zum Auflisten von Benutzern.

Anfrage

GET /api/v1/users/
Sie können mehrere Gruppen-IDs in den Abfrageparametern angeben:
GET /api/v1/users/?groupId=343&groupdId=12
Diese Abfrage gibt eine Liste aller Benutzer in den angegebenen Gruppen zurück.

Antwort

{ 
  "pid" : <integer>, 
  "userId": <integer>, 
  "username" : <string>,  
  "status" : <"ACTIVE"|"INACTIVE"|"LOCKED"> 
  "firstName" : <string>, 
  "lastName" : <string>, 
  "email : <string>, 
  "title" : <string_may_be_null>, 
  "phoneNumber" : <string_may_be_null>, 
  "groups" : [<group_1_id>, ...] 
 
}

Delete a User

Eine DELETE Methode zum Löschen eines Benutzers.

Anfrage

DELETE /api/v1/users/ <user_id>
Gibt 204 No Content bei erfolgreicher Ausführung zurück. Im Falle eines Konflikts gibt es 409 Conflict .

Benutzer stapelweise löschen

Eine POST Methode zum Massenlöschen mehrerer Benutzer.

Anfrage

POST /api/v1/users/bulk-delete

Stichprobenanforderungskörper

{[<user_id_1>, <user_id_2>, ...]}