Metodi API per la gestione degli utenti

Ridisporre i metodi API per gestire gli utenti, inclusi la creazione, l'aggiornamento, l'elenco, l'eliminazione e la restituzione di oggetti utente.

Creare un utente

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 di partner.

Restituisce 409 Conflict se il nome utente è già utilizzato.

Aggiornamento di un utente

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

Un metodo PUT per aggiornare l'utente attualmente connesso.

NOTA

Mentre la maggior parte dei metodi API sono chiamabili 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à utilizzato.

Aggiorna password utente con accesso

Un metodo PUT per aggiornare l'utente attualmente connesso.

NOTA

Mentre la maggior parte dei metodi API sono chiamabili 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 in caso di esito positivo. Restituisce 400 Bad Request se si verifica un errore in una delle due password.

Ripristina password utente connessa

Un metodo PUT per ripristinare l'utente attualmente connesso. Audience Management invia all'utente una password generata dal sistema.

NOTA

Mentre la maggior parte dei metodi API sono chiamabili solo dagli amministratori dei partner, questo metodo è richiamabile dagli utenti non amministratori.

Richiesta

POST /self/reset-password

Restituisce 200 OK in caso di esito positivo.

Restituisci oggetto utente per un ID utente

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

Restituisci oggetto utente per l'utente connesso

Un metodo Get per restituire l'oggetto utente per l'utente attualmente connesso.

NOTA

Mentre la maggior parte dei metodi API sono chiamabili 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>, ...] 
 
}

Elenca utenti

Un metodo GET 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 metodo DELETE per eliminare un utente.

Richiesta

DELETE /api/v1/users/<user_id>

Restituisce 204 No Content in caso di esito positivo. In caso di conflitto restituisce 409 Conflict.

Elimina utenti in blocco

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

In questa pagina

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now