Skip to main content
Skip table of contents

Accеss levels

Access levels

Returns a list of available access levels

GET /api/admin/v1/permissions

Parameters

string type – a role type, required for filtering roles by type, possible values are user or admin.

200 OK

Returns a list of access levels

JSON
[
    {
        "group": "Cameras",
        "permissions": [
            {
                "id": 58,
                "name": "cameras-inactive",
                "display_name": "View problematic cameras",
                "group": "Cameras"
            },
            {
                "id": 59,
                "name": "cameras-reset-issue",
                "display_name": "Cancel camera complaints",
                "group": "Cameras"
            },
            {
                "id": 60,
                "name": "cameras-search",
                "display_name": "Search for cameras",
                "group": "Cameras"
            },
            {
                "id": 61,
                "name": "cameras-statistic",
                "display_name": "View Statistics",
                "group": "Cameras"
            },
            {
                "id": 62,
                "name": "cameras-index",
                "display_name": "View Cameras",
                "group": "Cameras"
            },
            {
                "id": 63,
                "name": "cameras-store",
                "display_name": "Adding camera",
                "group": "Cameras"
            },
            {
                "id": 64,
                "name": "cameras-show",
                "display_name": "Camera View",
                "group": "Cameras"
            },
            {
                "id": 65,
                "name": "cameras-update",
                "display_name": "Camera Update",
                "group": "Cameras"
            },
            {
                "id": 66,
                "name": "cameras-destroy",
                "display_name": "Delete camera",
                "group": "Cameras"
            },
            {
                "id": 67,
                "name": "cameras-configs",
                "display_name": "View camera configurations",
                "group": "Cameras"
            },
            {
                "id": 68,
                "name": "groups-index",
                "display_name": "View camera tree",
                "group": "Cameras"
            },
            {
                "id": 69,
                "name": "groups-logins",
                "display_name": "View login groups",
                "group": "Cameras"
            },
            {
                "id": 70,
                "name": "camera-sensitive",
                "display_name": "View restricted cameras",
                "group": "Cameras"
            },
            {
                "id": 71,
                "name": "update-sensitive",
                "display_name": "Changing the limited access option for the camera",
                "group": "Cameras"
            },
            {
                "id": 104,
                "name": "config-templates-index",
                "display_name": "View all configurations",
                "group": "Cameras"
            },
            {
                "id": 105,
                "name": "config-templates-show",
                "display_name": "View configuration",
                "group": "Cameras"
            },
            {
                "id": 106,
                "name": "config-templates-store",
                "display_name": "Saving configuration",
                "group": "Cameras"
            },
            {
                "id": 107,
                "name": "config-templates-update",
                "display_name": "Configuration update",
                "group": "Cameras"
            },
            {
                "id": 108,
                "name": "config-templates-destroy",
                "display_name": "Delete configuration",
                "group": "Cameras"
            },
            {
                "id": 109,
                "name": "config-templates-get-base",
                "display_name": "Get basic configuration",
                "group": "Cameras"
            },
            {
                "id": 110,
                "name": "config-templates-set",
                "display_name": "Installing configuration in camera",
                "group": "Cameras"
            },
            {
                "id": 148,
                "name": "cameras-map",
                "display_name": "View cameras on the map",
                "group": "Cameras"
            },
            {
                "id": 172,
                "name": "camera-archive-recording-management",
                "display_name": "Activate or deactivate archive recording on the camera",
                "group": "Cameras"
            },
            {
                "id": 173,
                "name": "cameras-transfer",
                "display_name": "Move camera between branches",
                "group": "Cameras"
            },
            {
                "id": 174,
                "name": "cameras-update-public",
                "display_name": "External access update",
                "group": "Cameras"
            },
            {
                "id": 227,
                "name": "cameras-issues",
                "display_name": "View cameras with complaints",
                "group": "Cameras"
            },
            {
                "id": 265,
                "name": "camera-reload-indexes",
                "display_name": "Reloading indexes on the media server",
                "group": "Cameras"
            }
        ]
    },
    {
        "group": "Video streams",
        "permissions": [
            {
                "id": 72,
                "name": "streams-update",
                "display_name": "Updating video stream",
                "group": "Video streams"
            },
            {
                "id": 73,
                "name": "streams-store",
                "display_name": "Creating a video stream",
                "group": "Video streams"
            },
            {
                "id": 74,
                "name": "streams-destroy",
                "display_name": "Delete video stream",
                "group": "Video streams"
            },
            {
                "id": 75,
                "name": "streams-live",
                "display_name": "View video from camera",
                "group": "Video streams"
            },
            {
                "id": 76,
                "name": "archives-show",
                "display_name": "View archive",
                "group": "Video streams"
            },
            {
                "id": 78,
                "name": "archives-download",
                "display_name": "Save archive of video streams",
                "group": "Video streams"
            },
            {
                "id": 171,
                "name": "stream-restart",
                "display_name": "Restart video stream",
                "group": "Video streams"
            },
            {
                "id": 184,
                "name": "streams-transfer-between-server-update",
                "display_name": "Move stream between servers",
                "group": "Video streams"
            }
        ]
    },
    {
        "group": "Screenshots",
        "permissions": [
            {
                "id": 77,
                "name": "archives-preview-download",
                "display_name": "Saving camera screenshot",
                "group": "Screenshots"
            }
        ]
    },
    {
        "group": "Administrators",
        "permissions": [
            {
                "id": 80,
                "name": "admins-index",
                "display_name": "View Admins",
                "group": "Administrators"
            },
            {
                "id": 81,
                "name": "admins-store",
                "display_name": "Creating Administrator",
                "group": "Administrators"
            },
            {
                "id": 82,
                "name": "admins-show",
                "display_name": "View admin details",
                "group": "Administrators"
            },
            {
                "id": 83,
                "name": "admins-update",
                "display_name": "Admin Data Update",
                "group": "Administrators"
            },
            {
                "id": 84,
                "name": "admins-destroy",
                "display_name": "Delete Administrator",
                "group": "Administrators"
            },
            {
                "id": 144,
                "name": "dashboard-index",
                "display_name": "View Dashboard",
                "group": "Administrators"
            },
            {
                "id": 145,
                "name": "report",
                "display_name": "Receive reports",
                "group": "Administrators"
            },
            {
                "id": 146,
                "name": "network-devices-index",
                "display_name": "View network devices",
                "group": "Administrators"
            },
            {
                "id": 147,
                "name": "network-devices-show",
                "display_name": "View network device",
                "group": "Administrators"
            }
        ]
    },
    {
        "group": "DVRs",
        "permissions": [
            {
                "id": 85,
                "name": "dvrs-index",
                "display_name": "View DVRs",
                "group": "DVRs"
            },
            {
                "id": 86,
                "name": "dvrs-store",
                "display_name": "Adding DVR",
                "group": "DVRs"
            },
            {
                "id": 87,
                "name": "dvrs-show",
                "display_name": "View DVR",
                "group": "DVRs"
            },
            {
                "id": 88,
                "name": "dvrs-update",
                "display_name": "DVR update",
                "group": "DVRs"
            },
            {
                "id": 89,
                "name": "dvrs-destroy",
                "display_name": "Delete DVR",
                "group": "DVRs"
            }
        ]
    },
    {
        "group": "Events",
        "permissions": [
            {
                "id": 90,
                "name": "events-index",
                "display_name": "Event Viewer",
                "group": "Events"
            }
        ]
    },
    {
        "group": "PTZ",
        "permissions": [
            {
                "id": 91,
                "name": "ptz",
                "display_name": "PTZ Control",
                "group": "PTZ"
            }
        ]
    },
    {
        "group": "System Settings",
        "permissions": [
            {
                "id": 92,
                "name": "system-settings-index",
                "display_name": "Get system settings",
                "group": "System Settings"
            },
            {
                "id": 93,
                "name": "system-settings-update",
                "display_name": "Update system setting",
                "group": "System Settings"
            }
        ]
    },
    {
        "group": "Desktop clients",
        "permissions": [
            {
                "id": 94,
                "name": "thick-clients-index",
                "display_name": "List of desktop clients",
                "group": "Desktop clients"
            },
            {
                "id": 95,
                "name": "thick-clients-show",
                "display_name": "Get desktop client",
                "group": "Desktop clients"
            },
            {
                "id": 96,
                "name": "thick-clients-store",
                "display_name": "Create desktop clients",
                "group": "Desktop clients"
            },
            {
                "id": 97,
                "name": "thick-clients-update",
                "display_name": "Update desktop clients",
                "group": "Desktop clients"
            },
            {
                "id": 98,
                "name": "thick-clients-destroy",
                "display_name": "Delete desktop clients",
                "group": "Desktop clients"
            }
        ]
    },
    {
        "group": "Documents",
        "permissions": [
            {
                "id": 99,
                "name": "documents-index",
                "display_name": "Get documents",
                "group": "Documents"
            },
            {
                "id": 100,
                "name": "documents-show",
                "display_name": "Get document",
                "group": "Documents"
            },
            {
                "id": 101,
                "name": "documents-store",
                "display_name": "Create Document",
                "group": "Documents"
            },
            {
                "id": 102,
                "name": "documents-update",
                "display_name": "Update Document",
                "group": "Documents"
            },
            {
                "id": 103,
                "name": "documents-destroy",
                "display_name": "Delete document",
                "group": "Documents"
            }
        ]
    },
    {
        "group": "Remind DHCP",
        "permissions": [
            {
                "id": 111,
                "name": "dhcp-subnets-index",
                "display_name": "Display DHCP Networks",
                "group": "Remind DHCP"
            },
            {
                "id": 112,
                "name": "dhcp-subnets-store",
                "display_name": "Adding a DHCP network",
                "group": "Remind DHCP"
            },
            {
                "id": 113,
                "name": "dhcp-subnets-show",
                "display_name": "Display DHCP Network",
                "group": "Remind DHCP"
            },
            {
                "id": 114,
                "name": "dhcp-subnets-update",
                "display_name": "DHCP Network Update",
                "group": "Remind DHCP"
            },
            {
                "id": 115,
                "name": "dhcp-subnets-destroy",
                "display_name": "DHCP remote network",
                "group": "Remind DHCP"
            },
            {
                "id": 116,
                "name": "dhcp-subnets-apply",
                "display_name": "Applying configuration",
                "group": "Remind DHCP"
            },
            {
                "id": 190,
                "name": "dhcp-reservations-index",
                "display_name": "View DHCP Reserved List",
                "group": "Remind DHCP"
            },
            {
                "id": 191,
                "name": "dhcp-reservations-show",
                "display_name": "Display DHCP Reserved",
                "group": "Remind DHCP"
            },
            {
                "id": 192,
                "name": "dhcp-reservations-destroy",
                "display_name": "Remotely reserved DHCP",
                "group": "Remind DHCP"
            },
            {
                "id": 228,
                "name": "dhcp-subnet-group-index",
                "display_name": "List of DHCP pool groups",
                "group": "Remind DHCP"
            },
            {
                "id": 229,
                "name": "dhcp-subnet-group-store",
                "display_name": "Creating a DHCP pool group",
                "group": "Remind DHCP"
            },
            {
                "id": 230,
                "name": "dhcp-subnet-group-update",
                "display_name": "DHCP pool group update",
                "group": "Remind DHCP"
            },
            {
                "id": 231,
                "name": "dhcp-subnet-group-destroy",
                "display_name": "Deleting a DHCP pool group",
                "group": "Remind DHCP"
            },
            {
                "id": 232,
                "name": "dhcp-subnets-upload",
                "display_name": "Loading DHCP pools via Excel file",
                "group": "Remind DHCP"
            },
            {
                "id": 233,
                "name": "dhcp-subnet-group-show",
                "display_name": "Display DHCP pool group",
                "group": "Remind DHCP"
            }
        ]
    },
    {
        "group": "Servers",
        "permissions": [
            {
                "id": 117,
                "name": "servers-index",
                "display_name": "View media servers",
                "group": "Servers"
            },
            {
                "id": 118,
                "name": "servers-show",
                "display_name": "View Media Server",
                "group": "Servers"
            },
            {
                "id": 119,
                "name": "servers-store",
                "display_name": "Saving Media Server",
                "group": "Servers"
            },
            {
                "id": 120,
                "name": "servers-update",
                "display_name": "Media server update",
                "group": "Servers"
            },
            {
                "id": 121,
                "name": "servers-destroy",
                "display_name": "Deleting a media server",
                "group": "Servers"
            },
            {
                "id": 122,
                "name": "ntp-servers-index",
                "display_name": "View NTP servers",
                "group": "Servers"
            },
            {
                "id": 123,
                "name": "ntp-servers-show",
                "display_name": "View NTP server",
                "group": "Servers"
            },
            {
                "id": 124,
                "name": "ntp-servers-store",
                "display_name": "Saving NTP server",
                "group": "Servers"
            },
            {
                "id": 125,
                "name": "ntp-servers-update",
                "display_name": "NTP server update",
                "group": "Servers"
            },
            {
                "id": 126,
                "name": "ntp-servers-destroy",
                "display_name": "Removing NTP server",
                "group": "Servers"
            },
            {
                "id": 127,
                "name": "dhcp-servers-index",
                "display_name": "View DHCP servers",
                "group": "Servers"
            },
            {
                "id": 128,
                "name": "dhcp-servers-show",
                "display_name": "View DHCP server",
                "group": "Servers"
            },
            {
                "id": 129,
                "name": "dhcp-servers-store",
                "display_name": "Saving DHCP server",
                "group": "Servers"
            },
            {
                "id": 130,
                "name": "dhcp-servers-update",
                "display_name": "DHCP server update",
                "group": "Servers"
            },
            {
                "id": 131,
                "name": "dhcp-servers-destroy",
                "display_name": "Deleting a DHCP server",
                "group": "Servers"
            },
            {
                "id": 132,
                "name": "dhcp-servers-config-reload",
                "display_name": "Reloading DHCP server configuration",
                "group": "Servers"
            },
            {
                "id": 133,
                "name": "dhcp-servers-command",
                "display_name": "Send command to DHCP server",
                "group": "Servers"
            }
        ]
    },
    {
        "group": "Users",
        "permissions": [
            {
                "id": 134,
                "name": "users-index",
                "display_name": "View registered users",
                "group": "Users"
            },
            {
                "id": 135,
                "name": "users-show",
                "display_name": "User Details",
                "group": "Users"
            },
            {
                "id": 136,
                "name": "users-update",
                "display_name": "User Editing",
                "group": "Users"
            }
        ]
    },
    {
        "group": "Monitoring",
        "permissions": [
            {
                "id": 137,
                "name": "monitoring-index",
                "display_name": "View monitoring",
                "group": "Monitoring"
            }
        ]
    },
    {
        "group": "Special users",
        "permissions": [
            {
                "id": 139,
                "name": "special-users-index",
                "display_name": "View list of special users",
                "group": "Special Users"
            },
            {
                "id": 140,
                "name": "special-users-show",
                "display_name": "Display Special User",
                "group": "Special Users"
            },
            {
                "id": 141,
                "name": "special-users-store",
                "display_name": "Creating a special user",
                "group": "Special Users"
            },
            {
                "id": 142,
                "name": "special-users-update",
                "display_name": "Special User Update",
                "group": "Special Users"
            },
            {
                "id": 143,
                "name": "special-users-destroy",
                "display_name": "Delete special user",
                "group": "Special Users"
            }
        ]
    },
    {
        "group": "Media server groups",
        "permissions": [
            {
                "id": 149,
                "name": "packs-index",
                "display_name": "View list of media server groups",
                "group": "Media server groups"
            },
            {
                "id": 150,
                "name": "packs-show",
                "display_name": "View media server group",
                "group": "Media server groups"
            },
            {
                "id": 151,
                "name": "packs-store",
                "display_name": "Saving a group of media servers",
                "group": "Media server groups"
            },
            {
                "id": 152,
                "name": "packs-update",
                "display_name": "Media server group update",
                "group": "Media server groups"
            },
            {
                "id": 153,
                "name": "packs-destroy",
                "display_name": "Deleting a media server group",
                "group": "Media server groups"
            }
        ]
    },
    {
        "group": "Clusters",
        "permissions": [
            {
                "id": 154,
                "name": "cluster-index",
                "display_name": "View list of clusters",
                "group": "Clusters"
            },
            {
                "id": 155,
                "name": "cluster-show",
                "display_name": "Cluster View",
                "group": "Clusters"
            },
            {
                "id": 156,
                "name": "cluster-store",
                "display_name": "Saving Cluster",
                "group": "Clusters"
            },
            {
                "id": 157,
                "name": "cluster-update",
                "display_name": "Cluster Update",
                "group": "Clusters"
            },
            {
                "id": 158,
                "name": "cluster-destroy",
                "display_name": "Delete Cluster",
                "group": "Clusters"
            }
        ]
    },
    {
        "group": "Scripts",
        "permissions": [
            {
                "id": 159,
                "name": "scripts-index",
                "display_name": "View script list",
                "group": "Scripts"
            },
            {
                "id": 160,
                "name": "scripts-show",
                "display_name": "View script",
                "group": "Scripts"
            },
            {
                "id": 161,
                "name": "scripts-store",
                "display_name": "Saving script",
                "group": "Scripts"
            },
            {
                "id": 162,
                "name": "scripts-update",
                "display_name": "Script update",
                "group": "Scripts"
            },
            {
                "id": 163,
                "name": "scripts-destroy",
                "display_name": "Deleting script",
                "group": "Scripts"
            },
            {
                "id": 164,
                "name": "scripts-get-users",
                "display_name": "View list of users for scripts",
                "group": "Scripts"
            }
        ]
    },
    {
        "group": "External Events",
        "permissions": [
            {
                "id": 165,
                "name": "external-events-index",
                "display_name": "View list of external events",
                "group": "External Events"
            }
        ]
    },
    {
        "group": "Reactions to external events",
        "permissions": [
            {
                "id": 166,
                "name": "event-reactions-index",
                "display_name": "View a list of reactions to external events",
                "group": "Reactions to external events"
            }
        ]
    },
    {
        "group": "Translations",
        "permissions": [
            {
                "id": 168,
                "name": "dictionary-show",
                "display_name": "View translation",
                "group": "Translations"
            },
            {
                "id": 170,
                "name": "dictionary-update",
                "display_name": "Updating translation",
                "group": "Translations"
            }
        ]
    },
    {
        "group": "Analytics Servers",
        "permissions": [
            {
                "id": 179,
                "name": "analytic-servers-index",
                "display_name": "View analytics servers",
                "group": "Analytics Servers"
            }
        ]
    },
    {
        "group": "Roli",
        "permissions": [
            {
                "id": 185,
                "name": "roles-index",
                "display_name": "View list of roles",
                "group": "Roli"
            },
            {
                "id": 186,
                "name": "roles-store",
                "display_name": "Save role",
                "group": "Roli"
            },
            {
                "id": 187,
                "name": "roles-show",
                "display_name": "View Role",
                "group": "Roli"
            },
            {
                "id": 188,
                "name": "roles-update",
                "display_name": "Role Update",
                "group": "Roli"
            },
            {
                "id": 189,
                "name": "roles-destroy",
                "display_name": "Delete role",
                "group": "Roli"
            }
        ]
    },
    {
        "group": "Last Name",
        "permissions": [
            {
                "id": 193,
                "name": "tags-index",
                "display_name": "View tag list",
                "group": "Last Name"
            },
            {
                "id": 194,
                "name": "tags-store",
                "display_name": "Tag creation",
                "group": "Last Name"
            },
            {
                "id": 195,
                "name": "tags-show",
                "display_name": "View Tag",
                "group": "Last Name"
            },
            {
                "id": 196,
                "name": "tags-update",
                "display_name": "Tag Update",
                "group": "Last Name"
            },
            {
                "id": 197,
                "name": "tags-destroy",
                "display_name": "Delete tag",
                "group": "Last Name"
            }
        ]
    },
    {
        "group": "Remote cameras",
        "permissions": [
            {
                "id": 249,
                "name": "deleted-camera-index",
                "display_name": "List of remote cameras",
                "group": "Remote cameras"
            },
            {
                "id": 250,
                "name": "deleted-camera-show",
                "display_name": "View remote camera",
                "group": "Remote cameras"
            }
        ]
    },
    {
        "group": "Intercom",
        "permissions": [
            {
                "id": 253,
                "name": "intercom-index",
                "display_name": "View a list of intercoms",
                "group": "Intercom"
            },
            {
                "id": 254,
                "name": "intercom-show",
                "display_name": "View intercoms",
                "group": "Intercom"
            },
            {
                "id": 255,
                "name": "intercom-update",
                "display_name": "Intercom update",
                "group": "Intercom"
            },
            {
                "id": 257,
                "name": "intercom-log",
                "display_name": "View the list of intercom logs",
                "group": "Intercom"
            },
            {
                "id": 258,
                "name": "intercom-open-door",
                "display_name": "Opening the intercom door",
                "group": "Intercom"
            },
            {
                "id": 259,
                "name": "intercom-restart",
                "display_name": "Restart intercom",
                "group": "Intercom"
            },
            {
                "id": 260,
                "name": "intercom-keys",
                "display_name": "View the list of intercom keys",
                "group": "Intercom"
            }
        ]
    },
    {
        "group": "DB Backup",
        "permissions": [
            {
                "id": 262,
                "name": "backup-download",
                "display_name": "DB download",
                "group": "DB Backup"
            }
        ]
    },
    {
        "group": "Logo",
        "permissions": [
            {
                "id": 266,
                "name": "logo-index",
                "display_name": "Loading logo",
                "group": "Logo"
            }
        ]
    },
    {
        "group": "Provisioning",
        "permissions": [
            {
                "id": 270,
                "name": "camera-auto-provisioning",
                "display_name": "Camera auto-provisioning",
                "group": "Provisioning"
            }
        ]
    }
]

401 Unauthorized

Authorization token not sent or not valid

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/permissions' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "type": "string"
}'
PHP
PHP
$data = array (
  'type' => 'string',
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/permissions', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.