Metodi API per la gestione degli utenti

Ultimo aggiornamento: 2023-05-20
  • Argomenti:
  • API
    Visualizza ulteriori informazioni su questo argomento

Rest API metodi per gestire gli utenti, tra cui creazione, aggiornamento, elenco, eliminazione e restituzione di oggetti utente.

Crea un utente

A 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

A 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

A PUT per aggiornare l'utente attualmente connesso.

NOTA

Mentre gran parte API I metodi possono essere richiamati solo dagli amministratori partner. Questo metodo può essere chiamato anche da 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 connesso

A PUT per aggiornare l'utente attualmente connesso.

NOTA

Mentre gran parte API I metodi possono essere richiamati solo dagli amministratori partner. Questo metodo può essere chiamato anche da 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 è verificato un errore con una delle due password.

Reimposta password utente connesso

A PUT per reimpostare l'utente attualmente connesso. Audience Management invia all'utente una password generata dal sistema.

NOTA

Mentre gran parte API I metodi possono essere richiamati solo dagli amministratori partner. Questo metodo può essere chiamato anche da utenti non amministratori.

Richiesta

POST /self/reset-password

Restituisce 200 OK in caso di esito positivo.

Restituire un oggetto utente per un ID utente

A 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

A Get per restituire l'oggetto utente per l'utente attualmente connesso.

NOTA

Mentre gran parte API I metodi possono essere richiamati solo dagli amministratori partner. Questo metodo può essere chiamato anche da 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

A 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

A DELETE per eliminare un utente.

Richiesta

DELETE /api/v1/users/<user_id>

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

Elimina utenti in blocco

A 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