Subuser security group

Contains security group object structure and API calls related to security groups, that is, groups of sub-users with the specified set of rights and privileges.

Security group object structure

{
  "id": 103,
  "label": "Managers",
  "privileges": {
    "rights": ["tag_update", "tracker_register"],
    "store_period": "1d"
  }
}

id - int. Group id, can be null (when creating new security group).
label - string. Group label.
privileges - object containing privileges of group.
- rights - string array. A set of rights granted to security group (see below).
- store_period - optional string. Period of viewing history in legacy duration format, e.g. "2h" (2 hours), "3d" (3 days), "5m" (5 months), "1y" (one year).

Default security group

Default (or empty) security group is the group which is effective when sub-users' security_group_id is null. It has empty rights array.

Master user's rights

Master user always has all rights, including exclusive "admin" right.

Security group rights

Absolute majority of read operations does not require any rights (that is, they are available to all sub-users, even with "null" security group). However, some entities may be hidden because they are associated with the trackers unavailable to sub-user. Most of data-modifying operations, on the contrary, require some rights to be present.

Possible rights are:

name

description

admin

Available for master user-only. Cannot be assigned to security groups.

tracker_update

Allows adjustments to platform-related tracker settings, including labeling, tagging, changing phone numbers, LBS location settings, parking detection settings, odometer settings, engine hours settings, working statuses, data forwarding, connection timeout settings, inputs and sensors management, and BLE sensors management for some device models.

tracker_configure

Allows adjustments to hardware-related tracker settings that require sending device configuration commands. This includes tracking mode settings, ignition input settings, timezone settings, harsh driving settings, etc.

tracker_set_output

Allows changing the output state.

tracker_register

Allows activating new trackers.

tracker_rule_update

Allows creating and updating rules.

tag_update

Allows creating and updating tags.

task_update

Allows creating and updating tasks.

form_template_update

Allows creating and updating forms.

zone_update

Allows creating and updating geofences.

place_update

Allows creating and updating places.

places_custom_fields_update

Allows creating and updating custom fields for places.

employee_update

Allows creating and updating employees and drivers.

vehicle_update

Allows creating and updating vehicles, garages, and adding avatars to vehicles.

video_monitoring

Allows requesting real-time video, playback video, and video events.

payment_create

Allows interacting with the payment system assigned to a user.

reports

Allows generating all types of reports.

weblocator_session_create

Allows creating geo-links.

delivery_session_create

Allows using the delivery tracking functionality.

checkin_update

Allows creating check-ins.

API actions

API path: /subuser/security_group/.

create

Creates new security group.

required tariff features: multilevel_access – for ALL trackers.required sub-user rights: admin (available only to master users).

Parameters

name

description

type

group

security_group object without "id" field.

JSON object

Example

cURL

curl -X POST 'https://api.eu.navixy.com/v2/subuser/security_group/create' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "group": {"label": "Managers", "privileges": {"rights": ["tag_update", "tracker_register"], "store_period": "1d"}}}'

Response

{
  "success": true,
  "id": 103
}

id - int. An ID of the created security group.

Errors

13 – Operation not permitted – if user has insufficient rights.
236 – Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.

delete

Deletes existing security group. All sub-users belonging to this group will be assigned to default (null) security group.

required tariff features: multilevel_access – for ALL trackers.required sub-user rights: admin (available only to master users).

Parameters

name

description

type

security_group_id

ID of security group, which must be deleted.

int

Examples

curl -X POST 'https://api.eu.navixy.com/v2/subuser/security_group/delete' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "id": 103}'

Response

{
  "success": true
}

Errors

13 – Operation not permitted – if user has insufficient rights.
201 – Not found in the database – when group with the specified security_group_id does not exist.
236 – Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.

list

List all security groups belonging to current user.

required tariff features: multilevel_access – for ALL trackers.required sub-user rights: admin (available only to master users).

Parameters

Only API key hash.

Examples

curl -X POST 'https://api.eu.navixy.com/v2/subuser/security_group/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b"}'

Response

{
  "success": true,
  "list": [
    {
      "id": 103,
      "label": "Managers",
      "privileges": {
        "rights": ["tag_update", "tracker_register"],
        "store_period": "1d"
      }
    }
  ]
}

list - array of objects. List of all security groups belonging to this master account.

Errors

13 – Operation not permitted – if user has insufficient rights.
236 – Feature unavailable due to tariff restrictions (if there is at least one tracker without multilevel_access tariff feature).

update

Updates existing security group.

required tariff features: multilevel_access – for ALL trackers.required sub-user rights: admin (available only to master users).

Parameters

name

description

type

group

security_group with "id" field.

JSON object

Example

cURL

curl -X POST 'https://api.eu.navixy.com/v2/subuser/security_group/update' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "group": {"id": 103, "label": "Managers", "privileges": {"rights": ["tag_update", "tracker_register"], "store_period": "1d"}}}'

Response

{
  "success": true
}

Errors

13 – Operation not permitted – if user has insufficient rights.
201 – Not found in the database – when security group with the specified ID does not exist.
236 – Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.

assign

Assigns (removes) a security group to sub-users.

required tariff features: multilevel_access – for ALL trackers.required sub-user rights: admin (available only to master users).

Parameters

name

description

type

group_id

Nullable, ID of a security group

int

subuser_ids

IDs of sub-users

int array

Example

cURL

curl -X POST 'https://api.eu.navixy.com/v2/subuser/security_group/assign' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "group_id": 3, subuser_ids: [12, 34]}'

Response

{
  "success": true
}

Errors

13 – Operation not permitted – if user has insufficient rights.
201 – Not found in the database – when security group with the specified ID does not exist.
236 – Feature unavailable due to tariff restrictions - if there is at least one tracker without multilevel_access tariff feature.

PreviousSubuser places NextSubuser session

Last updated 5 months ago

Was this helpful?