API-Methoden für die Benutzerverwaltung user-management-api-methods
REST API -Methoden zum Verwalten von Benutzern, einschließlich Erstellen, Aktualisieren, Auflisten, Löschen und Zurückgeben von Benutzerobjekten.
Erstellen eines Benutzers create-user
Eine POST
-Methode zum Erstellen eines neuen Benutzers.
Anfrage
POST /api/v1/users/
Beispielanfragetext
{
"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 isAdmin
auf "true"gesetzt ist, wird der Benutzer als Partner-Administrator erstellt. Diese Eigenschaft informiert Sie auch darüber, ob ein Benutzer Partneradministrator ist.
Gibt 409 Conflict
zurück, wenn der Benutzername bereits verwendet wurde.
Aktualisieren eines Benutzers update-user
Eine PUT
-Methode zum Aktualisieren eines Benutzers.
Anfrage
PUT /api/v1/users/
<userId>
Beispielanfragetext
{
"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 409 Conflict
zurück, wenn der Benutzername bereits verwendet wurde.
Aktualisierter angemeldeter Benutzer update-logged-in-user
Eine PUT
-Methode zum Aktualisieren des aktuell angemeldeten Benutzers.
Anfrage
PUT /self/update
Beispielanfragetext
{
"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 409 Conflict
zurück, wenn der Benutzername bereits verwendet wurde.
Aktualisieren des angemeldeten Benutzerkennworts update-logged-in-user-pw
Eine PUT
-Methode zum Aktualisieren des aktuell angemeldeten Benutzers.
Anfrage
POST /users/self/update-password
Beispielanfragetext
{ "oldPassword" : "old password", "newPassword" : "new password" }
Gibt bei Erfolg 200 OK
zurück. Gibt 400 Bad Request
zurück, wenn bei einem der beiden Passwörter etwas nicht stimmt.
Zurücksetzen des angemeldeten Benutzerkennworts reset-logged-in-user-pw
Eine PUT
-Methode zum Zurücksetzen des derzeit angemeldeten Benutzers. Audience Management sendet dem Benutzer ein vom System generiertes Kennwort.
Anfrage
POST /self/reset-password
Gibt bei Erfolg 200 OK
zurück.
Zurückgeben eines Benutzerobjekts für eine Benutzer-ID return-user-object-for-id
Eine Get
-Methode, um das Benutzerobjekt für eine Benutzer-ID zurückzugeben.
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>, ...]
}
Zurückgeben des Benutzerobjekts für angemeldeten Benutzer return-user-object-for-logged-in-user
Eine Get
-Methode, um das Benutzerobjekt für den derzeit angemeldeten Benutzer zurückzugeben.
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 list-users
Eine GET
-Methode zur Auflistung 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>, ...]
}
Löschen eines Benutzers delete-users
Eine DELETE
-Methode zum Löschen eines Benutzers.
Anfrage
DELETE /api/v1/users/
<user_id>
Gibt bei Erfolg 204 No Content
zurück. Im Falle eines Konflikts wird 409 Conflict
zurückgegeben.
Benutzer stapelweise löschen delete-users-bulk
Eine POST
-Methode zum Löschen mehrerer Benutzer in großen Mengen.
Anfrage
POST /api/v1/users/bulk-delete
Beispielanfragetext
{[<user_id_1>, <user_id_2>, ...]}