User Management-API-Methoden user-management-api-methods

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

Benutzer erstellen create-user

Eine POST Methode zum Erstellen eines neuen Benutzers.

Anfrage

POST /api/v1/users/

Beispiel-Anfrageinhalt

{
  "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-Admin erstellt. Diese Eigenschaft informiert Sie auch darüber, ob ein Benutzer ein Partneradministrator ist.

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

Aktualisieren von Benutzern update-user

Eine PUT Methode zum Aktualisieren eines Benutzers.

Anfrage

PUT /api/v1/users/<userId>

Beispiel-Anfrageinhalt

{
  "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 wird.

Angemeldeter Benutzer aktualisieren update-logged-in-user

Eine PUT Methode zum Aktualisieren des aktuell angemeldeten Benutzers.

Anfrage

PUT /self/update

Beispiel-Anfrageinhalt

{
  "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 wird.

Aktualisieren des angemeldeten Benutzerkennworts update-logged-in-user-pw

Eine PUT Methode zum Aktualisieren des aktuell angemeldeten Benutzers.

Anfrage

POST /users/self/update-password

Beispiel-Anfrageinhalt

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

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

Angemeldetes Benutzerkennwort zurücksetzen reset-logged-in-user-pw

Eine PUT Methode zum Zurücksetzen des aktuell angemeldeten Benutzers. Audience Management sendet dem Benutzer ein systemgeneriertes Kennwort.

Anfrage

POST /self/reset-password

Gibt bei Erfolg 200 OK zurück.

Ausgabe des 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>, ...]

}

Rückgabe des Benutzerobjekts für angemeldeten Benutzer return-user-object-for-logged-in-user

Eine Get Methode, um das Benutzerobjekt für den aktuell 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 zum Auflisten von Benutzern.

Anfrage

GET /api/v1/users/

Sie können in den Abfrageparametern mehrere Gruppen-IDs 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 von Benutzern 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 Konfliktfall gibt 409 Conflict zurück.

Benutzer stapelweise löschen delete-users-bulk

Eine POST Methode zum Massenlöschen mehrerer Benutzer.

Anfrage

POST /api/v1/users/bulk-delete

Beispiel-Anfrageinhalt

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