Metodi API per la gestione degli utenti user-management-api-methods
Utilizzare i metodi API per gestire gli utenti, ad esempio la creazione, l'aggiornamento, l'elenco, l'eliminazione e la restituzione di oggetti utente.
Crea un utente create-user
Un metodo POST
per creare un nuovo utente.
Richiesta
POST /api/v1/users/
Corpo della richiesta di esempio
{
"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
}
Risposta
{
"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">
}
Se isAdmin
è impostato su true, l'utente viene creato come amministratore partner. Questa proprietà consente inoltre di sapere se un utente è un amministratore partner.
Restituisce 409 Conflict
se il nome utente è già utilizzato.
Aggiornare un utente update-user
Un metodo PUT
per aggiornare un utente.
Richiesta
PUT /api/v1/users/
<userId>
Corpo della richiesta di esempio
{
"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>, ...]
}
Risposta
{
"pid" : <integer>,
"userId": <integer>,
"username" : <string>,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"groups" : [<group_1_id>, ...]
}
Restituisce 409 Conflict
se il nome utente è già utilizzato.
Aggiorna utente connesso update-logged-in-user
Un metodo PUT
per aggiornare l'utente attualmente connesso.
Richiesta
PUT /self/update
Corpo della richiesta di esempio
{
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>,
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
Risposta
{
"userId": <integer>,,
"status" : <"ACTIVE"|"INACTIVE"|"LOCKED">
"firstName" : <string>,
"lastName" : <string>,
"email" : <string>
"title" : <string_may_be_null>,
"phoneNumber" : <string_may_be_null>
}
Restituisce 409 Conflict
se il nome utente è già utilizzato.
Aggiorna password utente connesso update-logged-in-user-pw
Un metodo PUT
per aggiornare l'utente attualmente connesso.
Richiesta
POST /users/self/update-password
Corpo della richiesta di esempio
{ "oldPassword" : "old password", "newPassword" : "new password" }
In caso di esito positivo, restituisce 200 OK
. Restituisce 400 Bad Request
se si è verificato un errore con una delle due password.
Reimposta password utente connesso reset-logged-in-user-pw
Un metodo PUT
per reimpostare l'utente attualmente connesso. Audience Management invia all'utente una password generata dal sistema.
Richiesta
POST /self/reset-password
In caso di esito positivo, restituisce 200 OK
.
Restituire un oggetto utente per un ID utente return-user-object-for-id
Un metodo Get
per restituire l'oggetto utente per un ID utente.
Richiesta
GET /api/v1/users/
<userId>
Risposta
{
"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>, ...]
}
Oggetto utente restituito per l'utente connesso return-user-object-for-logged-in-user
Un metodo Get
per restituire l'oggetto utente per l'utente attualmente connesso.
Richiesta
GET /api/v1/users/self
Risposta
{
"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>, ...]
}
Elenca utenti list-users
Un metodo GET
per elencare gli utenti.
Richiesta
GET /api/v1/users/
Puoi specificare più ID gruppo nei parametri della query:
GET /api/v1/users/?groupId=343&groupdId=12
Questa query restituisce un elenco di tutti gli utenti nei gruppi specificati.
Risposta
{
"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>, ...]
}
Eliminare un utente delete-users
Un metodo DELETE
per eliminare un utente.
Richiesta
DELETE /api/v1/users/
<user_id>
In caso di esito positivo, restituisce 204 No Content
. In caso di conflitto restituisce 409 Conflict
.
Elimina utenti in blocco delete-users-bulk
Un metodo POST
per eliminare più utenti in blocco.
Richiesta
POST /api/v1/users/bulk-delete
Corpo della richiesta di esempio
{[<user_id_1>, <user_id_2>, ...]}