Passa al contenuto principale

Utenti

Recupero di tutti gli utenti​

Richiesta​

Definizione​

GET /api/v1/users

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"List of users"
403"Forbidden"

Corpo della risposta​

  • data.users.id string

    Codice identificativo dell'utente.

  • data.users.username string

    Username dell'utente.

  • data.users.first_name string

    Nome dell'utente.

  • data.users.last_name string

    Cognome dell'utente.

  • data.users.auth_type string

    Tipo di autenticazione usata dall'utente.

  • data.users.is_first_access boolean

    Indica se è il primo accesso dell'utente.

  • data.users.is_disabled boolean

    Indica se l'utente è disabilitato.

  • data.users.password_updated_at string

    Data dell'ultima modifica della password dell'utente.

  • data.users.attrs_updated_at string

    Data dell'ultima volta che gli attributi utente sono stati modificati.

  • data.users.email string

    Email dell'utente.

  • data.users.groups array<object>

    Lista di Gruppi a cui l'utente appartiene.

  • data.users.inserted_at string

    Data in cui l'utente è stato creato.

Recupero di uno specifico utente​

Richiesta​

Definizione​

GET /api/v1/users/{id}

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"User retrieved"
400"Error retrieving user"
403"Forbidden"

Corpo della risposta​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:41Z",
      "auth_type": "basic",
      "email": "test@test.it",
      "first_name": "FirstTest",
      "groups": [],
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:41Z",
      "is_disabled": false,
      "is_first_access": true,
      "last_name": "LastTest",
      "password_updated_at": "2024-01-17T13:11:41Z",
      "username": "test"
    }
  },
  "message": "User retrieved",
  "status": "ok"
}

Creazione di un utente​

Richiesta​

Definizione​

POST /api/v1/users

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "user": {
    "auth_type": "basic",
    "email": "test@test.it",
    "first_name": "FirstTest",
    "last_name": "LastTest",
    "password": "Password",
    "password_confirmation": "Password",
    "username": "test"
  }
}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"User created succesfully."
400"Error creating new user."
400"Generic error"
403"Forbidden"

Corpo di risposta​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:40Z",
      "auth_type": "basic",
      "email": "test@test.it",
      "first_name": "FirstTest",
      "groups": [],
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:40Z",
      "is_disabled": false,
      "is_first_access": true,
      "last_name": "LastTest",
      "password_updated_at": "2024-01-17T13:11:40Z",
      "settings": {
        "gui_display_mode": "light",
        "timezone": "Europe/Rome"
      },
      "username": "test"
    }
  },
  "message": "User created succesfully.",
  "status": "ok"
}

Modifica di un utente​

Richiesta​

Definizione​

PUT /api/v1/users/{id}

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "attrs": {
    "email": "new_email@test.it"
  }
}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"User updated succesfully."
400"Error updating the user"
403"Forbidden"

Corpo della risposta​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:39Z",
      "auth_type": "basic",
      "email": "new_email@test.it",
      "first_name": "FirstTest",
      "groups": [],
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:39Z",
      "is_disabled": false,
      "is_first_access": true,
      "last_name": "LastTest",
      "password_updated_at": "2024-01-17T13:11:39Z",
      "settings": {
        "gui_display_mode": "light",
        "timezone": "Europe/Rome"
      },
      "username": "test"
    }
  },
  "message": "User updated succesfully.",
  "status": "ok"
}

Cambio della password​

Richiesta​

Definizione​

POST /api/v1/users/{id}/change_password

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "attrs": {
    "password": "Password",
    "password_confirmation": "Password"
  },
  "curr_password": "password"
}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"Password updated succesfully"
400"Error updating the password"
400"Error revoking user sessions"
403"Forbidden"

Body​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:22Z",
      "auth_type": "basic",
      "email": "user@seerbox",
      "first_name": null,
      "groups": [
        {
          "id": "fdxxcc2e-xxxx-4c34-xxxx-a7a7xxxbfxxb",
          "name": "admins"
        }
      ],
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:22Z",
      "is_disabled": false,
      "is_first_access": false,
      "last_name": null,
      "password_updated_at": "2024-01-17T13:11:42Z",
      "username": "username"
    }
  },
  "message": "Password updated succesfully",
  "status": "ok"
}

Reset della password​

Richiesta​

Definizione​

POST /api/v1/users/{id}/reset_password

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Corpo della richiesta​

{
  "attrs": {
    "password": "Password",
    "password_confirmation": "Password"
  }
}

Risposta​

Codici di stato​

Codici di statoMessaggio
200"Password reset succesfully"
400"Error resetting the password"
400"Error revoking user sessions"
403"Forbidden"

Corpo della risposta​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:38Z",
      "auth_type": "basic",
      "email": "test@test.it",
      "first_name": "FirstTest",
      "groups": [],
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:38Z",
      "is_disabled": false,
      "is_first_access": true,
      "last_name": "LastTest",
      "password_updated_at": "2024-01-17T13:11:38Z",
      "settings": {
        "gui_display_mode": "light",
        "timezone": "Europe/Rome"
      },
      "username": "test"
    }
  },
  "message": "Password reset succesfully",
  "status": "ok"
}

Eliminazione di un utente​

Richiesta​

Definizione​

DELETE /api/v1/users/{id}

Header​

  • Authorization richiesto

    Token di autenticazione con privilegi di lettura per la risorsa.

    Bearer {token}

  • Content-Type richiesto

    application/json

Risposta​

Codici di stato​

Codici di statoMessaggio
200"User deleted succesfully."
400"Error deleting the user."
400"Error revoking user sessions"
403"Forbidden"

Corpo della risposta​

{
  "data": {
    "user": {
      "access_limits": null,
      "attrs_updated_at": "2024-01-17T13:11:36Z",
      "auth_type": "basic",
      "email": "test@test.it",
      "first_name": "FirstTest",
      "id": "a8axx6e5-xxxxx-4768-xxxx-699xxxx908ab",
      "inserted_at": "2024-01-17T13:11:36Z",
      "is_disabled": false,
      "is_first_access": true,
      "last_name": "LastTest",
      "password_updated_at": "2024-01-17T13:11:36Z",
      "username": "test"
    }
  },
  "message": "User deleted succesfully.",
  "status": "ok"
}