---
title: "List user"
method: POST
path: "/user/list"
tags: ["Users"]
---

# List user

`POST /user/list`

## Query parameters

- `page` integer
- `sizePage` integer
- `sortField` string
- `sortDirection` 'ASC' | 'DESC'

## Request body

- UserFilter
  - `idUser` string — Id user
  - `fullName` string, nullable — Full name
  - `firstName` string, nullable — First name
  - `lastName` string, nullable — Last name
  - `middleName` string, nullable — Middle name
  - `password` string, nullable
  - `passwordValidate` string, nullable
  - `oldPassword` string, nullable — Only administrator users will not have to confirm the old password
  - `comments` string, nullable — Comments for user
  - `lastConnect` integer, nullable — User last connect utimestamp
  - `registered` string, nullable — User registration date
  - `email` string, nullable — User email address
  - `phone` string, nullable — User phone number
  - `isAdmin` boolean — User is administrator
  - `language` 'catalonian' | 'english' | 'spanish' | 'french' | 'japanese' | 'russian' | 'chinese' — User section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
  - `timezone` string, nullable — User timezone, https://www.php.net/manual/en/datetimezone.listidentifiers.php
  - `blockSize` integer, nullable — User default block pagination size
  - `idSkin` integer, nullable — User id skin
  - `disabled` boolean — Disabling this user
  - `shortcut` integer, nullable — User shortcut
  - `shortcutData` string, nullable — User shorcut data
  - `section` 'default' | 'visual_console' | 'event_list' | 'group_view' | 'group_view' | 'tactical_view' | 'alert_detail' | 'external_link' | 'other' | 'dashboard' — User section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
  - `dataSection` string, nullable — User section data
  - `metaconsoleSection` 'default' | 'visual_console' | 'event_list' | 'group_view' | 'group_view' | 'tactical_view' | 'alert_detail' | 'external_link' | 'other' | 'dashboard' — User Metaconsole section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
  - `metaconsoleDataSection` string, nullable — User metaconsole section data
  - `forceChangePass` boolean — Force the user to change the password on next login
  - `lastPassChange` string, nullable — Date of last password change
  - `lastFailedLogin` string, nullable — Date of last login failure
  - `failedAttempt` integer — Number of failed login attempts by a user
  - `loginBlocked` boolean — Blocked user
  - `metaconsoleAccess` string, nullable — User metaconsole access
  - `notLogin` boolean — The user with no access authorization can only access the API.
  - `localUser` boolean — The user with local authentication enabled will always use local authentication.
  - `metaconsoleAgentsManager` integer, nullable — Agents manager
  - `metaconsoleAccessNode` integer, nullable — Access node
  - `strictAcl` boolean — User with ACL strict
  - `idFilter` integer, nullable — Assign a specific filter for user
  - `sessionTime` integer, nullable — This is defined in minutes. If you want a permanent session, introduce -1 in this field.
  - `defaultEventFilter` integer, nullable — Assign a specific filter in events for user
  - `metaconsoleDefaultEventFilter` integer, nullable — Assign a specific filter in events for user metaconsole
  - `showTipsStartup` boolean — User show tips startup
  - `autorefreshWhiteList` string — User pages autorefresh
  - `timeAutorefresh` integer — Interval of autorefresh of the elements, by default they are 30 seconds, needing to enable the autorefresh first
  - `defaultCustomView` integer, nullable — default custom view for user
  - `ehorusUserLevelUser` string — user access ehorus whit user name
  - `ehorusUserLevelPass` string — user access ehorus whit user token
  - `ehorusUserLevelEnabled` boolean — User access ehorus level
  - `itsmUserLevelUser` string — user access ITSM whit user name
  - `itsmUserLevelPass` string — user access ITSM whit user token
  - `apiToken` string — Api key
  - `allowedIpActive` boolean — User allowed ip active
  - `allowedIpList` string, nullable — User allowed Ip List
  - `sessionMaxTimeExpire` integer, nullable — user expire session time
  - `authTokenSecret` string — Auth token
  - `freeSearch` string, nullable — Find word in fullname and comments fields.
  - `multipleSearchString` MultipleSearch
    - `field` string, nullable — Field to search of query
    - `data` integer[], nullable — Values to search of query IN()

## Response `200`

List Incidence object

- object
  - `paginationData` PaginationData — Info pagination data
    - `totalPages` integer, nullable — Number of pages
    - `sizePage` integer, nullable — Items per page
    - `totalRegisters` integer, nullable — Number of items
    - `totalRegistersPage` integer, nullable — Number of items this page
    - `currentPage` integer, nullable — Number of current page
  - `data` User[]
    - `idUser` string — Id user
    - `fullName` string, nullable — Full name
    - `firstName` string, nullable — First name
    - `lastName` string, nullable — Last name
    - `middleName` string, nullable — Middle name
    - `password` string, nullable
    - `passwordValidate` string, nullable
    - `oldPassword` string, nullable — Only administrator users will not have to confirm the old password
    - `comments` string, nullable — Comments for user
    - `lastConnect` integer, nullable — User last connect utimestamp
    - `registered` string, nullable — User registration date
    - `email` string, nullable — User email address
    - `phone` string, nullable — User phone number
    - `isAdmin` boolean — User is administrator
    - `language` 'catalonian' | 'english' | 'spanish' | 'french' | 'japanese' | 'russian' | 'chinese' — User section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
    - `timezone` string, nullable — User timezone, https://www.php.net/manual/en/datetimezone.listidentifiers.php
    - `blockSize` integer, nullable — User default block pagination size
    - `idSkin` integer, nullable — User id skin
    - `disabled` boolean — Disabling this user
    - `shortcut` integer, nullable — User shortcut
    - `shortcutData` string, nullable — User shorcut data
    - `section` 'default' | 'visual_console' | 'event_list' | 'group_view' | 'group_view' | 'tactical_view' | 'alert_detail' | 'external_link' | 'other' | 'dashboard' — User section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
    - `dataSection` string, nullable — User section data
    - `metaconsoleSection` 'default' | 'visual_console' | 'event_list' | 'group_view' | 'group_view' | 'tactical_view' | 'alert_detail' | 'external_link' | 'other' | 'dashboard' — User Metaconsole section, the available sections are: default, visual_console, event_list, group_view, group_view, tactical_view, alert_detail, external_link, other, dashboard
    - `metaconsoleDataSection` string, nullable — User metaconsole section data
    - `forceChangePass` boolean — Force the user to change the password on next login
    - `lastPassChange` string, nullable — Date of last password change
    - `lastFailedLogin` string, nullable — Date of last login failure
    - `failedAttempt` integer — Number of failed login attempts by a user
    - `loginBlocked` boolean — Blocked user
    - `metaconsoleAccess` string, nullable — User metaconsole access
    - `notLogin` boolean — The user with no access authorization can only access the API.
    - `localUser` boolean — The user with local authentication enabled will always use local authentication.
    - `metaconsoleAgentsManager` integer, nullable — Agents manager
    - `metaconsoleAccessNode` integer, nullable — Access node
    - `strictAcl` boolean — User with ACL strict
    - `idFilter` integer, nullable — Assign a specific filter for user
    - `sessionTime` integer, nullable — This is defined in minutes. If you want a permanent session, introduce -1 in this field.
    - `defaultEventFilter` integer, nullable — Assign a specific filter in events for user
    - `metaconsoleDefaultEventFilter` integer, nullable — Assign a specific filter in events for user metaconsole
    - `showTipsStartup` boolean — User show tips startup
    - `autorefreshWhiteList` string — User pages autorefresh
    - `timeAutorefresh` integer — Interval of autorefresh of the elements, by default they are 30 seconds, needing to enable the autorefresh first
    - `defaultCustomView` integer, nullable — default custom view for user
    - `ehorusUserLevelUser` string — user access ehorus whit user name
    - `ehorusUserLevelPass` string — user access ehorus whit user token
    - `ehorusUserLevelEnabled` boolean — User access ehorus level
    - `itsmUserLevelUser` string — user access ITSM whit user name
    - `itsmUserLevelPass` string — user access ITSM whit user token
    - `apiToken` string — Api key
    - `allowedIpActive` boolean — User allowed ip active
    - `allowedIpList` string, nullable — User allowed Ip List
    - `sessionMaxTimeExpire` integer, nullable — user expire session time
    - `authTokenSecret` string — Auth token

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/pandorafms/apis/api-pandora-fms.md) · [All operations](https://skmtc.net/pandorafms/apis/api-pandora-fms/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pandorafms/api-pandora-fms/versions/f18688ffd894/schema)