View Source

Roles and users operation is described by three proto-files:

SecurityService.proto contains the objects definition, their properties and methods.
GlobalPermissions.proto contains the properties of the global access parameters.
ObjectsPermissions.proto contains the parameters properties to access the specific objects.

Methods in SecurityService.proto:

message ListConfigRequest − request the configuration.
message ChangeConfigRequest − create/edit/delete the configuration.
message ListGlobalPermissionsRequest − request the global access parameters.
message SetGlobalPermissionsRequest − set the global access parameters.
message ListObjectPermissionsRequest − request the parameters to access the specific objects.
message SetObjectPermissionsRequest − set the parameters to access the specific objects.

Properties in SecurityService.proto:

The Role object (message Role):

Property	Description
index	GUID
name	Role name
comment	Comment
timezone_id	The ID of the role operation time zone

The simultaneous connections limit (message ConnectionRestrictions):

Property	Description
web_count	Maximum number of web app connections
mobile_count	Maximum number of mobile app connections

The User object (message User):

Property	Description
index	GUID
login name	User name
comment	Comment
date_created	Date of creation
date_expires	Sertificate expiration date
enabled	Is activated
ldap_server_id	LDAP Server ID
ldap_domain_name	LDAP Server Name
ConnectionRestrictions restrictions	A set of message ConnectionRestrictions properties (see above)

The user and role connection (message UserAssignment):

Property	Description
user_id	User id
role_id	Role id

The LDAP object (message LDAPServer):

Property	Description
index	GUID
server_name	Server name or IP adress
friendly_name	Name
port	Port
base_dn	Base DN
login	User
password	Password
use_ssl	Use secure connection (SSL)
search_filter	Search filter
login_attribute	Login attribute
dn_attribute	DN attribute

Properties in GlobalPermissions.proto:

The PTZ control priority (enum ETelemetryPriority):

Property	Description
TELEMETRY_PRIORITY_UNSPECIFIED	The PTZ control priority is not specified
TELEMETRY_PRIORITY_NO_ACCESS	No access
TELEMETRY_PRIORITY_LOWEST	Minimum level
TELEMETRY_PRIORITY_LOW	Low level
TELEMETRY_PRIORITY_NORMAL	Medium level
TELEMETRY_PRIORITY_HIGH	High level
TELEMETRY_PRIORITY_HIGHEST	Maximum level

The map access (enum EMapAccess):

Property	Description
MAP_ACCESS_UNSPECIFIED	The map access is not specified
MAP_ACCESS_FORBID	The map access is forbidden
MAP_ACCESS_VIEW_ONLY	You can only view maps
MAP_ACCESS_VIEW_SCALE	You can move and scale maps
MAP_ACCESS_FULL	All options available

The features access (enum EFeatureAccess):

Property	Description
FEATURE_ACCESS_FORBID_ALL	All features are forbidden
FEATURE_ACCESS_DEVICES_SETUP	Device settings (see Hardware configuration)
FEATURE_ACCESS_ARCHIVES_SETUP	Archive settings (see Аrchive)
FEATURE_ACCESS_DETECTORS_SETUP	Detection settings (see Detectors)
FEATURE_ACCESS_USERS_RIGHTS_SETUP	User permission settings (see General information about users)
FEATURE_ACCESS_CHANGING_LAYOUTS	Editing layouts (see Configuring layouts)
FEATURE_ACCESS_EXPORT	Exporting snapshots and video recordings (see Exporting frames and video recordings)
FEATURE_ACCESS_LAYOUTS_TAB	Access to Layouts tab (see Layouts management)
FEATURE_ACCESS_SETTINGS_SETUP	Options settings (see System preferences)
FEATURE_ACCESS_MINMAX_BUTTON_ALLOWED	Minimizing the Client to the system tray (see Interface of Axxon One)
FEATURE_ACCESS_SYSTEM_JOURNAL	Viewing the system log (see System log)
FEATURE_ACCESS_DOMAIN_MANAGING_OPS	Managing an Axxon domain (see Axxon Domain operations)
FEATURE_ACCESS_ADD_CAMERA_TO_LAYOUT_IN_MONITORING	Adding a camera to a layout in live video mode (see Adding cameras to cells)
FEATURE_ACCESS_SEARCH	Archive search (see Video surveillance in the Archive Search mode)
FEATURE_ACCESS_EDIT_PTZ_PRESETS	Adding and editing presets for PTZ cameras (see Control Using the Presets List)
FEATURE_ACCESS_PROGRAMMING_SETUP	Programming setup (see Programming)
FEATURE_ACCESS_WEB_UI_LOGIN	Access to the Web server (see Working with Axxon One through the Web-Client)
FEATURE_ACCESS_COMMENT	User comments for recorded video (see Operator comments)
FEATURE_ACCESS_ALLOW_BUTTON_MENU_CAMERA	Context menu of a video camera in a viewing tile (see Context Menu of the Surveillance window)
FEATURE_ACCESS_ALLOW_SHOW_TITLES	Displaying captions (see Viewing titles from POS terminals)
FEATURE_ACCESS_SHOW_ERROR_MESSAGES	Show error messages (see Event control)

Alarms Management (enum EAlertAccess):

Property	Description
ALERT_ACCESS_UNSPECIFIED	The alarms access is not specified
ALERT_ACCESS_FORBID	Users have no access to alarm videos
ALERT_ACCESS_VIEW_ONLY	Users can view alarm videos but they can't evaluate alarms
ALERT_ACCESS_FULL	Users can view alarm videos and evaluate alarms

Unlimited access to all features (enum EUnrestrictedAccess):

Property	Description
UNRESTRICTED_ACCESS_UNSPECIFIED	Unlimited access is not specified
UNRESTRICTED_ACCESS_NO	Unlimited access is forbidden
UNRESTRICTED_ACCESS_YES	Unlimited access to all features

Properties in ObjectsPermissions.proto:

The video camera access (enum ECameraAccess):

Property	Description
CAMERA_ACCESS_UNSPECIFIED	The video camera access is not specified
CAMERA_ACCESS_FORBID	You cannot access the device
CAMERA_ACCESS_MONITORING_ON_PROTECTION	You can view video from the camera only when the camera is armed
CAMERA_ACCESS_MONITORING	You can live video from the camera. Other functions and device configuration are not available
CAMERA_ACCESS_ARCHIVE	You can view live and recorded video from the camera. You cannot arm/disarm/configure the camera
CAMERA_ACCESS_MONITORING_ARCHIVE_MANAGE	All functions available. You cannot configure the device
CAMERA_ACCESS_FULL	All functions and settings available

The microphone access (enum EMicrophoneAccess):

Property	Description
MICROPHONE_ACCESS_UNSPECIFIED	The microphone access is not specified
MICROPHONE_ACCESS_FORBID	The user is unable to listen to live sound from the video camera. The user is unable to listen to sound recordings from the archive
MICROPHONE_ACCESS_MONITORING	The user is able to listen to live sound from the video camera (the microphone must be turned on). The user is unable to listen to sound recordings from the archive
MICROPHONE_ACCESS_FULL	All functions are accessible

The PTZ access (enum ETelemetryAccess):

Property	Description
TELEMETRY_ACCESS_UNSPECIFIED	The PTZ access is not specified
TELEMETRY_ACCESS_FORBID	The user cannot control pan/tilt/zoom
TELEMETRY_ACCESS_CONTROL	The user can control pan/tilt/zoom

The archive access (enum EArchiveAccess):

Property	Description
ARCHIVE_ACCESS_UNSPECIFIED	The archive access is not specified
ARCHIVE_ACCESS_FORBID	Access is not provided to this archive
ARCHIVE_ACCESS_FULL	Archive is available for all functions

The video walls access (EVideowallAccess):

Property	Description
VIDEOWALL_ACCESS_UNSPECIFIED	The video walls access is not specified
VIDEOWALL_ACCESS_FORBID	The access is forbidden
VIDEOWALL_ACCESS_FULL	The access is granted