Documentation for Axxon One 1.0.

Previous page gRPC API general information  Recognition lists Next page

Configuring user permissions

Manage users using gRPC API methods

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

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

Methods in SecuriteService.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):

PropertyDescription
indexGUID
nameRole name
commentComment
timezone_id

The ID of the role operation time zone

The simultaneous connections limit (message ConnectionRestrictions):

PropertyDescription
web_countMaximum number of web app connections
mobile_countMaximum number of mobile app connections

The User object (message User):

PropertyDescription
indexGUID

login

name

User name

commentComment
date_createdDate of creation
date_expiresSertificate expiration date
enabledIs activated
ldap_server_idLDAP Server ID
ldap_domain_nameLDAP Server Name
ConnectionRestrictions restrictions A set of message ConnectionRestrictions properties (see above)

The user and role connection (message UserAssignment):

PropertyDescription
user_idUser id
role_idRole id

The LDAP object (message LDAPServer):

PropertyDescription
indexGUID
server_nameServer name or IP adress
friendly_nameName
portPort
base_dnBase DN
loginUser
passwordPassword
use_sslUse secure connection (SSL)
search_filterSearch filter
login_attributeLogin attribute
dn_attributeDN attribute

Properties in GlobalPermissions.proto:

The PTZ control priority (enum ETelemetryPriority):

PropertyDescription
TELEMETRY_PRIORITY_UNSPECIFIEDThe PTZ control priority is not specified
TELEMETRY_PRIORITY_NO_ACCESS
No access
TELEMETRY_PRIORITY_LOWESTMinimum level
TELEMETRY_PRIORITY_LOWLow level
TELEMETRY_PRIORITY_NORMALMedium level
TELEMETRY_PRIORITY_HIGHHigh level
TELEMETRY_PRIORITY_HIGHESTMaximum level

The map access (enum EMapAccess):

PropertyDescription
MAP_ACCESS_UNSPECIFIEDThe map access is not specified
MAP_ACCESS_FORBIDThe map access is forbidden
MAP_ACCESS_VIEW_ONLYYou can only view maps
MAP_ACCESS_VIEW_SCALEYou can move and scale maps
MAP_ACCESS_FULLAll options available

The features access (enum EFeatureAccess):

PropertyDescription
FEATURE_ACCESS_FORBID_ALLAll features are forbidden
FEATURE_ACCESS_DEVICES_SETUPDevice settings (see Hardware configuration)
FEATURE_ACCESS_ARCHIVES_SETUPArchive settings (see Configuring archives)
FEATURE_ACCESS_DETECTORS_SETUPDetection settings (see Configuring detection tools)
FEATURE_ACCESS_USERS_RIGHTS_SETUPUser permission settings (see Configuring user permissions)
FEATURE_ACCESS_CHANGING_LAYOUTSEditing layouts (see Configuring layouts)
FEATURE_ACCESS_EXPORTExporting snapshots and video recordings (see Exporting frames and video recordings)
FEATURE_ACCESS_LAYOUTS_TABAccess to Layouts tab (see Layouts management)
FEATURE_ACCESS_SETTINGS_SETUPOptions settings (see System preferences)
FEATURE_ACCESS_MINMAX_BUTTON_ALLOWEDMinimizing the Client to the system tray (see Interface of the Axxon One Software Package)
FEATURE_ACCESS_SYSTEM_JOURNALViewing the system log (see The System Log)
FEATURE_ACCESS_DOMAIN_MANAGING_OPSManaging an Axxon domain (see Axxon Domain operations)
FEATURE_ACCESS_ADD_CAMERA_TO_LAYOUT_IN_MONITORINGAdding a camera to a layout in live video mode (see Adding cameras to cells)
FEATURE_ACCESS_SEARCHArchive search (see Video surveillance in archive search mode)
FEATURE_ACCESS_EDIT_PTZ_PRESETSAdding and editing presets for PTZ cameras (see Control Using the Presets List)
FEATURE_ACCESS_PROGRAMMING_SETUPProgramming setup (see Configuring macros)
FEATURE_ACCESS_WEB_UI_LOGINAccess to the Web server (see Working with Axxon One Through the Web-Client)
FEATURE_ACCESS_COMMENTUser comments for recorded video (see Operator comments)
FEATURE_ACCESS_ALLOW_BUTTON_MENU_CAMERAContext menu of a video camera in a viewing tile (see Viewing Tile Context Menu)
FEATURE_ACCESS_ALLOW_SHOW_TITLESDisplaying captions (see Viewing titles from POS terminals)
FEATURE_ACCESS_SHOW_ERROR_MESSAGESShow error messages (see Event control)

Alarms Management (enum EAlertAccess):

PropertyDescription
ALERT_ACCESS_UNSPECIFIEDThe alarms access is not specified
ALERT_ACCESS_FORBIDUsers have no access to alarm videos
ALERT_ACCESS_VIEW_ONLYUsers can view alarm videos but they can't evaluate alarms
ALERT_ACCESS_FULLUsers can view alarm videos and evaluate alarms

Unlimited access to all features (enum EUnrestrictedAccess):

PropertyDescription
UNRESTRICTED_ACCESS_UNSPECIFIEDUnlimited access is not specified
UNRESTRICTED_ACCESS_NOUnlimited access is forbidden
UNRESTRICTED_ACCESS_YESUnlimited access to all features

Properties in ObjectsPermissions.proto:

The video camera access (enum ECameraAccess):

PropertyDescription
CAMERA_ACCESS_UNSPECIFIEDThe video camera access is not specified
CAMERA_ACCESS_FORBIDYou cannot access the device
CAMERA_ACCESS_MONITORING_ON_PROTECTIONYou can view video from the camera only when the camera is armed
CAMERA_ACCESS_MONITORINGYou can live video from the camera. Other functions and device configuration are not available
CAMERA_ACCESS_ARCHIVEYou can view live and recorded video from the camera. You cannot arm/disarm/configure the camera
CAMERA_ACCESS_MONITORING_ARCHIVE_MANAGEAll functions available. You cannot configure the device
CAMERA_ACCESS_FULLAll functions and settings available

The microphone access (enum EMicrophoneAccess):

PropertyDescription
MICROPHONE_ACCESS_UNSPECIFIEDThe microphone access is not specified
MICROPHONE_ACCESS_FORBIDThe 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_MONITORINGThe 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_FULLAll functions are accessible

The PTZ access (enum ETelemetryAccess):

PropertyDescription
TELEMETRY_ACCESS_UNSPECIFIEDThe PTZ access is not specified
TELEMETRY_ACCESS_FORBIDThe user cannot control pan/tilt/zoom
TELEMETRY_ACCESS_CONTROLThe user can control pan/tilt/zoom

The archive access (enum EArchiveAccess):

PropertyDescription
ARCHIVE_ACCESS_UNSPECIFIEDThe archive access is not specified
ARCHIVE_ACCESS_FORBIDAccess is not provided to this archive
ARCHIVE_ACCESS_FULLArchive is available for all functions

The video walls access (EVideowallAccess):

PropertyDescription
VIDEOWALL_ACCESS_UNSPECIFIEDThe video walls access is not specified
VIDEOWALL_ACCESS_FORBIDThe access is forbidden
VIDEOWALL_ACCESS_FULLThe access is granted
  • No labels