Elencare utenti

API che per ottenere un elenco filtrato di utenti con i relativi ruoli e informazioni di stato.

[GET] /api/v3/users

Header

Gli header richiesti dalla chiamata sono gli header standard di TSDigital.

Il Content-Type deve essere application/json

Query Parameters

Parametri obbligatori

• itemId: identificativo univoco dell' azienda per cui è richiesto l'elenco degli utenti

Parametri opzionali

• roles: elenco separato da virgole di ruoli da ricercare.
• appIds: elenco separato da virgole di appId da ricercare
• featureCodes: elenco separato da virgole di feature code da ricercare
• userTypes: elenco separato da virgole di userTypes da ricercare. I valori accettati sono T per le utenze tecniche, P per le utenze personali
• userId: identificativo univoco dell'utenza da cercare
• policyIds: elenco per la ricerca per policy id , ad esempio è possibile cercare gli utenti per una determinata connessione
• sortBy.field: indica il campo su cui va fatto l'ordinamento, come valori sono accettati EMAIL(default), LAST_NAME, FIRST_NAME, DESCRIPTION, CREATED_AT, ACTIVE
• sortBy.order: ASC (default) per un ordinamento crescente, DESC per un ordinamento decrescente
• unpaged:  false (default) per una lista paginata, true per una lista non paginata.

Se unpaged è false i seguenti parametri diventano obbligatori.

• pagination.pageNumber: numero della pagina da recuperare. La prima pagina è 0
• pagination.itemPerPage: numero di utenti da recuperare per pagina.

Risposte

L'operazione è avvenuta con successo se e solo se il codice HTTP della risposta è 200. Ogni altro codice di risposta indica uno stato di errore.

HTTP 200

L'elenco di utenti è stato recuperato con successo.

{
  "totalItems": 0,
  "roleCount": {
    "OWNER": 0,
    "ADMIN": 0,
    ...
  },
  "users": [
    {
      "roles": [
        {
          "appId": "string",
          "resourceId": "string",
          "actionKey": "string",
          "featureCode": "string",
          "resourceUuid": "string",
          "policyId": "policyId",
          "createdAt": "2020-09-11T10:01:15.512Z",
          "createdBy": "string"
        }
      ],
      "profile": {
        "id": "string",
        "type": "string",
        "description": "string",
        "firstName": "string",
        "lastName": "string",
        "language": "string",
        "tsid": "string",
        "ncsId": "string",
        "uuid": "string"
      },
      "status": {
        "active": true,
        "activatedAt": "2020-09-11T10:01:15.512Z",
        "activatedBy": "string",
        "createdAt": "2020-09-11T10:01:15.512Z",
        "createdBy": "string",
        "modifiedAt": "2020-09-11T10:01:15.512Z",
        "modifiedBy": "string",
        "deleted": true,
        "deletedAt": "2020-09-11T10:01:15.512Z",
        "deletedBy": "string"
      }
    }
  ]
}

• totalItems: numero totale degli utenti che rispettano i filtri specificati
• roleCount: numero di utenti raggruppati per ruoli
• users: array di User che rispettano i filtri specificati.

HTTP 400

Uno o più parametri forniti nella richiesta sono errati, o mancano dei parametri obbligatori.

HTTP 401

Il token autorizzativo è scaduto, invalido o non è stato specificato.

HTTP 403

Il token autorizzativo fornito è valido, ma l'utente non ha i permessi necessari a creare una connessione per il gestore specificato. 

HTTP 500

Il server ha riscontrato un errore inaspettato nella creazione della richiesta di connessione

HTTP 502

Il server ha riscontrato un errore inaspettato nel comunicare con un servizio dal quale dipende per poter completare il processo (ad esempio, il servizio di auth non risulta essere disponibile)

Tutte le risposte d'errore condividono il seguente formato per il body di risposta:

{
  "code": "string",
  "message": "string",
  "subErrors": [
    {}
  ],
  "timestamp": "dd-MM-yyyy HH:mm:ss"
}

• code: corrisponde al codice d'errore HTTP ritornato (es: 500)
• message: messaggio d'errore (es: Errore interno del server)
• subErrors: eventuali errori innestati in quello ritornato
• timestamp: data ed ora di ritorno dell'errore