v1

latestOpenAPI 3.0.02026-07-174822119.2 KB
Users

Updates an user

put/user/{idUser}

Path parameters

idUserstring required

User id

Request body

idUserstring

Id user

fullNamestring nullable

Full name

firstNamestring nullable

First name

lastNamestring nullable

Last name

middleNamestring nullable

Middle name

passwordstring nullable
passwordValidatestring nullable
oldPasswordstring nullable

Only administrator users will not have to confirm the old password

commentsstring nullable

Comments for user

lastConnectinteger nullable

User last connect utimestamp

registeredstring nullable

User registration date

emailstring nullable

User email address

phonestring nullable

User phone number

isAdminboolean

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

blockSizeinteger nullable

User default block pagination size

idSkininteger nullable

User id skin

disabledboolean

Disabling this user

shortcutinteger nullable

User shortcut

shortcutDatastring 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

dataSectionstring 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

metaconsoleDataSectionstring nullable

User metaconsole section data

forceChangePassboolean

Force the user to change the password on next login

lastPassChangestring nullable

Date of last password change

lastFailedLoginstring nullable

Date of last login failure

failedAttemptinteger

Number of failed login attempts by a user

loginBlockedboolean

Blocked user

metaconsoleAccessstring nullable

User metaconsole access

notLoginboolean

The user with no access authorization can only access the API.

localUserboolean

The user with local authentication enabled will always use local authentication.

metaconsoleAgentsManagerinteger nullable

Agents manager

metaconsoleAccessNodeinteger nullable

Access node

strictAclboolean

User with ACL strict

idFilterinteger nullable

Assign a specific filter for user

sessionTimeinteger nullable

This is defined in minutes. If you want a permanent session, introduce -1 in this field.

defaultEventFilterinteger nullable

Assign a specific filter in events for user

metaconsoleDefaultEventFilterinteger nullable

Assign a specific filter in events for user metaconsole

showTipsStartupboolean

User show tips startup

autorefreshWhiteListstring

User pages autorefresh

timeAutorefreshinteger

Interval of autorefresh of the elements, by default they are 30 seconds, needing to enable the autorefresh first

defaultCustomViewinteger nullable

default custom view for user

ehorusUserLevelUserstring

user access ehorus whit user name

ehorusUserLevelPassstring

user access ehorus whit user token

ehorusUserLevelEnabledboolean

User access ehorus level

itsmUserLevelUserstring

user access ITSM whit user name

itsmUserLevelPassstring

user access ITSM whit user token

apiTokenstring

Api key

allowedIpActiveboolean

User allowed ip active

allowedIpListstring nullable

User allowed Ip List

sessionMaxTimeExpireinteger nullable

user expire session time

authTokenSecretstring

Auth token

Example request

{
  "comments": "The user is allergic",
  "registered": "2023-02-21 08:34:16",
  "email": "nobody@samplecompany.com",
  "phone": "555-555-555",
  "lastPassChange": "2023-02-21 08:34:16",
  "lastFailedLogin": "2023-02-21 08:34:16"
}

Response

User object

idUserstring

Id user

fullNamestring nullable

Full name

firstNamestring nullable

First name

lastNamestring nullable

Last name

middleNamestring nullable

Middle name

passwordstring nullable
passwordValidatestring nullable
oldPasswordstring nullable

Only administrator users will not have to confirm the old password

commentsstring nullable

Comments for user

lastConnectinteger nullable

User last connect utimestamp

registeredstring nullable

User registration date

emailstring nullable

User email address

phonestring nullable

User phone number

isAdminboolean

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

blockSizeinteger nullable

User default block pagination size

idSkininteger nullable

User id skin

disabledboolean

Disabling this user

shortcutinteger nullable

User shortcut

shortcutDatastring 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

dataSectionstring 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

metaconsoleDataSectionstring nullable

User metaconsole section data

forceChangePassboolean

Force the user to change the password on next login

lastPassChangestring nullable

Date of last password change

lastFailedLoginstring nullable

Date of last login failure

failedAttemptinteger

Number of failed login attempts by a user

loginBlockedboolean

Blocked user

metaconsoleAccessstring nullable

User metaconsole access

notLoginboolean

The user with no access authorization can only access the API.

localUserboolean

The user with local authentication enabled will always use local authentication.

metaconsoleAgentsManagerinteger nullable

Agents manager

metaconsoleAccessNodeinteger nullable

Access node

strictAclboolean

User with ACL strict

idFilterinteger nullable

Assign a specific filter for user

sessionTimeinteger nullable

This is defined in minutes. If you want a permanent session, introduce -1 in this field.

defaultEventFilterinteger nullable

Assign a specific filter in events for user

metaconsoleDefaultEventFilterinteger nullable

Assign a specific filter in events for user metaconsole

showTipsStartupboolean

User show tips startup

autorefreshWhiteListstring

User pages autorefresh

timeAutorefreshinteger

Interval of autorefresh of the elements, by default they are 30 seconds, needing to enable the autorefresh first

defaultCustomViewinteger nullable

default custom view for user

ehorusUserLevelUserstring

user access ehorus whit user name

ehorusUserLevelPassstring

user access ehorus whit user token

ehorusUserLevelEnabledboolean

User access ehorus level

itsmUserLevelUserstring

user access ITSM whit user name

itsmUserLevelPassstring

user access ITSM whit user token

apiTokenstring

Api key

allowedIpActiveboolean

User allowed ip active

allowedIpListstring nullable

User allowed Ip List

sessionMaxTimeExpireinteger nullable

user expire session time

authTokenSecretstring

Auth token

Example response

{
  "comments": "The user is allergic",
  "registered": "2023-02-21 08:34:16",
  "email": "nobody@samplecompany.com",
  "phone": "555-555-555",
  "lastPassChange": "2023-02-21 08:34:16",
  "lastFailedLogin": "2023-02-21 08:34:16"
}