For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sub-user security group

Named sets of rights assigned to sub-users, deciding what each of them may change.

A security group is a named set of rights. Assigning one to a sub-user decides what that sub-user may change, which is the half of their limits that scoping does not cover: scoping decides what they can see, rights decide what they can do to it.

Security group object

Default security group

The default, or empty, security group applies when a sub-user's security_group_id is null. Its rights array is empty, so such a sub-user can change nothing.

Master user's rights

A master user always holds every right, including the admin right, which cannot be assigned to a security group.

Security group rights

Almost every read operation requires no rights at all, so it is available to any sub-user, even one in the default group. Entities can still be hidden from such a sub-user, because they are associated with trackers outside that sub-user's scope. Most operations that change data, by contrast, do require a right.

These are the rights a security group can grant:

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 base path: /subuser/security_group.

Every operation on this page needs the multilevel_access tariff feature on all trackers, and the admin right, which is available only to master users. Failing either returns error 13 for the right and error 236 for the feature, so those two are not repeated per operation below.


Create security group

post
/subuser/security_group/create

Create a security group, and return its ID.

Master users only, and the account needs the multilevel_access plan feature on all trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.

Requires the admin right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
Responses
200

The created group

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
idintegerOptional

ID of the new security group.

post/subuser/security_group/create
POST /v2/subuser/security_group/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "group": {
    "id": null,
    "label": "text",
    "privileges": {
      "rights": [
        "tracker_update"
      ],
      "store_period": "text"
    }
  }
}
{
  "success": true,
  "id": 1
}

Errors

These errors come in addition to the general error codes:

  • 13 - The caller is a sub-user.

  • 236 - The account lacks the multilevel_access feature.


Delete security group

post
/subuser/security_group/delete

Delete a security group.

Sub-users in it fall back to the default group, which has no rights.

Master users only, and the account needs the multilevel_access plan feature on all trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.

Also accepts GET with the same parameters as query-string values.

Requires the admin right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
security_group_idinteger · min: 1Required

ID of the security group to delete.

Responses
200

Security group deleted

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/subuser/security_group/delete
POST /v2/subuser/security_group/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "security_group_id": 1
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when no group has the given security_group_id.


List security groups

post
/subuser/security_group/list

List the security groups of the current master account.

Master users only, and the account needs the multilevel_access plan feature on all trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.

Callable with an empty body. Also accepts GET.

Requires the admin right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses
200

The security groups

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/subuser/security_group/list
POST /v2/subuser/security_group/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "list": [
    {
      "id": null,
      "label": "text",
      "privileges": {
        "rights": [
          "tracker_update"
        ],
        "store_period": "text"
      }
    }
  ]
}

Errors

These errors come in addition to the general error codes:

  • 13 - The caller is a sub-user.

  • 236 - The account lacks the multilevel_access feature.


Update security group

post
/subuser/security_group/update

Update a security group. Pass a full group object including its id.

The change takes effect for every sub-user in the group, including sessions already open.

Master users only, and the account needs the multilevel_access plan feature on all trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.

Requires the admin right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
Responses
200

Security group updated

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/subuser/security_group/update
POST /v2/subuser/security_group/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "group": {
    "id": null,
    "label": "text",
    "privileges": {
      "rights": [
        "tracker_update"
      ],
      "store_period": "text"
    }
  }
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when the group does not exist.


Assign security group

post
/subuser/security_group/assign

Put one or more sub-users into a security group.

Pass group_id as null to move them to the default group, which has no rights. Only subuser_ids is required.

Master users only, and the account needs the multilevel_access plan feature on all trackers. A sub-user calling this gets error 13, and an account without the feature gets error 236.

Requires the admin right.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
group_idinteger · nullableOptional

ID of the security group. Null moves the sub-users to the default group.

subuser_idsinteger[] · min: 1Required

IDs of the sub-users to assign. Must not be empty.

Responses
200

Security group assigned

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/subuser/security_group/assign
POST /v2/subuser/security_group/assign HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "group_id": null,
  "subuser_ids": [
    1
  ]
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database, when the group or the sub-user does not exist.

Last updated

Was this helpful?