Show Menu
ARGOMENTI×

Metodi API di gestione utenti

Metodi API di riposo per gestire gli utenti, inclusi creazione, aggiornamento, elenco, eliminazione e restituzione di oggetti utente.

Creazione di un utente

Un POST metodo 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 di partner.
Restituisce 409 Conflict se il nome utente è già stato usato.

Aggiornare un utente

Un PUT metodo 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à stato usato.

Aggiorna utente connesso

Un PUT metodo per aggiornare l’utente attualmente connesso.
Mentre la maggior parte API dei metodi è richiamabile solo dagli amministratori dei partner, questo metodo è richiamabile dagli utenti non amministratori.

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à stato usato.

Aggiorna password utente con accesso

Un PUT metodo per aggiornare l’utente attualmente connesso.
Mentre la maggior parte API dei metodi è richiamabile solo dagli amministratori dei partner, questo metodo è richiamabile dagli utenti non amministratori.

Richiesta

POST /users/self/update-password

Corpo della richiesta di esempio

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

Restituisce 200 OK se ha esito positivo. Restituisce 400 Bad Request se si verifica un errore in una delle due password.

Reimposta password utente di accesso

Un PUT metodo per ripristinare l’utente attualmente connesso. Audience Management invia all'utente una password generata dal sistema.
Mentre la maggior parte API dei metodi è richiamabile solo dagli amministratori dei partner, questo metodo è richiamabile dagli utenti non amministratori.

Richiesta

POST /self/reset-password
Restituisce 200 OK se ha esito positivo.

Restituisci oggetto utente per un ID utente

Un Get metodo 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>, ...] 
 
}

Restituisci oggetto utente per l’utente connesso

Un Get metodo per restituire l’oggetto utente all’utente attualmente connesso.
Mentre la maggior parte API dei metodi è richiamabile solo dagli amministratori dei partner, questo metodo è richiamabile dagli utenti non amministratori.

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>, ...] 
 
}

Utenti elenco

Un GET metodo per elencare gli utenti.

Richiesta

GET /api/v1/users/
Potete specificare più ID gruppo nei parametri di 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

Un DELETE metodo per eliminare un utente.

Richiesta

DELETE /api/v1/users/ <user_id>
Restituisce 204 No Content se ha esito positivo. In caso di ritorno a un conflitto 409 Conflict .

Elimina utenti in blocco

Un POST metodo per eliminare più utenti in massa.

Richiesta

POST /api/v1/users/bulk-delete

Corpo della richiesta di esempio

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