User settings description

Request to get the settings:

https://[address_server]:[port]/settings/users/?sid=[id_session]

Response:

{
    "name" : "users",
    "type" : "UsersFolder",
    "subdirs" : [
        "Admin",
        "Demo",
        "IXWkytqU",
        "Script",
        "XZoJlPC2",
        "user_add"
    ],
    "values" : [
        "local_operator",
        "local_operator_logout"
    ]
}

Table 128. 

subdirs Description TRASSIR
Admin Admin user settings ≥3.1
Demo Demo user settings ≥3.1
Script Settings of Script user ≥3.1
[GUID_user] User settings ≥3.1
[GUID_group] Settings of group user rights ≥3.1
user_add Create new user or new group ≥3.1

Request to get settings for a user group:

https://[address_server]:[port]/settings/users/[GUID_group]/?sid=[id_session]

Response:

{
    "name" : "IXWkytqU",
    "type" : "Group",
    "subdirs" : [

    ],
    "values" : [
        "acl",
        "archive_speed_limit",
        "base_rights",
        "can_change_password",
        "icon",
        "name",
        "notes",
        "ptz_priority",
        "saveable_icon",
        "settings_button",
        "shutdown_button",
        "templates_managing",
        "templates_sharing",
        "view_button"
    ]
}

Request to get user settings:

https://[address_server]:[port]/settings/users/[GUID_user]/?sid=[id_session]

Response:

{
    "name" : "XZoJlPC2",
    "type" : "User",
    "subdirs" : [

    ],
    "values" : [
        "acl",
        "analytics_rights",
        "archive_speed_limit",
        "base_rights",
        "can_change_password",
        "cloud_login_offline_ttl_sec",
        "cloud_utc_offset_minutes",
        "enable_analytics",
        "enable_local",
        "enable_remote",
        "enable_web",
        "from_cloud",
        "group",
        "group_changed",
        "icon",
        "internal_revision",
        "last_login_address",
        "last_login_time",
        "name",
        "notes",
        "password",
        "password_empty_warning",
        "ptz_priority",
        "random_passwords",
        "roles",
        "saveable_icon",
        "settings_button",
        "shutdown_button",
        "templates_managing",
        "templates_sharing",
        "timer_id",
        "view_button"
    ]
}

Retrieve a value (R):

https://[address_server]:[port]/settings/users/[GUID_group]/[setting]?sid=[id_session]
https://[address_server]:[port]/settings/users/[GUID_user]/[setting]?sid=[id_session]

Write a value (W):

https://[address_server]:[port]/settings/users/GUID_group/[setting]=[value]?sid=[id_session]
https://[address_server]:[port]/settings/users/[GUID_user]/[setting]=[value]?sid=[id_session]

Table 129. 

values Description Type   TRASSIR
acl   string RW ≥3.1
analytics_rights User rights for analytics string RW ≥4.0
archive_speed_limit Archive writing speed limit integer RW ≥4.0
base_rights Group/user basic rights integer RW ≥3.1
can_change_password

User/group is allowed to change the password:

0 - no, 1 - yes

integer RW ≥3.3
cloud_login_offline_ttl_sec   integer R ≥4.0
cloud_utc_offset_minutes   integer R ≥4.0
enable_analytics

User is allowed network analytics:

0 - no, 1 - yes

integer RW ≥4.0
enable_local

User is allowed local login:

0 - no, 1 - yes

integer RW ≥3.1
enable_remote

User is allowed remote connection:

0 - no, 1 - yes

integer RW ≥3.1
enable_web

User is allowed connecting via browser/mobile app:

0 - no, 1 - yes

integer RW ≥4.1
from_cloud

Cloud user:

0 - no, 1 - yes

integer RW ≥3.3
group User group GUID string RW ≥3.2
group_changed   integer RW ≥3.2
icon User/group icon path string RW ≥3.1
internal_revision   integer RW ≥3.2
last_login_address Last user login address string RW ≥3.1
last_login_time Last user login date and time in UNIX time format string R ≥3.1
name Group/user name string RW ≥3.1
notes   string RW ≥3.1
password User password string W ≥3.1
password_empty_warning   integer RW ≥3.1
ptz_priority PTZ priority integer RW ≥3.1
random_passwords   string W ≥3.3
roles Cloud user rights string R ≥4.0
saveable_icon User/group icon path string RW ≥3.1
settings_button

The "Settings" button is allowed to a user/group:

0 - no, 1 - yes

integer RW ≥3.1
shutdown_button Allow shutdown button integer RW ≥3.1
templates_managing

User/group is allowed template managing:

0 - no, 1 - yes

integer RW ≥3.1
templates_sharing

User/group is allowed sharing templates to the cloud:

0 - no, 1 - yes

integer RW ≥4.0
timer_id   string R ≥4.0
view_button

A "View" button is allowed user/group:

0 - no, 1 - yes

integer RW ≥3.2

Tip

See description of adding new users or user group requests in Requests for adding new users or user groups.

See also