Users and access

Permissions

User permissions and other object linking

Fetch permission links between Objects

GET

https://demo.traccar.org/api/permissions

Provide exactly two *Id query parameters matching the Permission body shape (e.g. reportId and deviceId). Use 0 on a side to mean "any", e.g. ?reportId=5&deviceId=0 lists all devices linked to report 5. At least one side must be non-zero.

Fetch permission links between Objects

curl -X GET 'https://demo.traccar.org/api/permissions' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE'

const response = await fetch('https://demo.traccar.org/api/permissions', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.traccar.org/api/permissions',
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    },
)
print(response.text)

200

[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]

Response

200OKArray<Permission>

Response fields application/json

Array<Permission>

Show child attributes

This is a permission map that contain two object indexes. It is used to link/unlink objects. Order is important. Example: { deviceId:8, geofenceId: 16 }

userIdinteger<int64>

User id, can be only first parameter

deviceIdinteger<int64>

Device id, can be first parameter or second only in combination with userId

groupIdinteger<int64>

Group id, can be first parameter or second only in combination with userId

geofenceIdinteger<int64>

Geofence id, can be second parameter only

notificationIdinteger<int64>

Notification id, can be second parameter only

calendarIdinteger<int64>

Calendar id, can be second parameter only and only in combination with userId

attributeIdinteger<int64>

Computed attribute id, can be second parameter only

driverIdinteger<int64>

Driver id, can be second parameter only

managedUserIdinteger<int64>

User id, can be second parameter only and only in combination with userId

commandIdinteger<int64>

Saved command id, can be second parameter only

400Bad Request

Bad request

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Link an Object to another Object

POST

https://demo.traccar.org/api/permissions

Link an Object to another Object

curl -X POST 'https://demo.traccar.org/api/permissions' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}'

const body = `{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}`;

const response = await fetch('https://demo.traccar.org/api/permissions', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}'''

response = requests.post(
    'https://demo.traccar.org/api/permissions',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}

Body

application/json

This is a permission map that contain two object indexes. It is used to link/unlink objects. Order is important. Example: { deviceId:8, geofenceId: 16 }

userIdinteger<int64>

User id, can be only first parameter

deviceIdinteger<int64>

Device id, can be first parameter or second only in combination with userId

groupIdinteger<int64>

Group id, can be first parameter or second only in combination with userId

geofenceIdinteger<int64>

Geofence id, can be second parameter only

notificationIdinteger<int64>

Notification id, can be second parameter only

calendarIdinteger<int64>

Calendar id, can be second parameter only and only in combination with userId

attributeIdinteger<int64>

Computed attribute id, can be second parameter only

driverIdinteger<int64>

Driver id, can be second parameter only

managedUserIdinteger<int64>

User id, can be second parameter only and only in combination with userId

commandIdinteger<int64>

Saved command id, can be second parameter only

Response

204No Content

No Content

400Bad Request

No permission

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Unlink an Object from another Object

DELETE

https://demo.traccar.org/api/permissions

Unlink an Object from another Object

curl -X DELETE 'https://demo.traccar.org/api/permissions' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}'

const body = `{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}`;

const response = await fetch('https://demo.traccar.org/api/permissions', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}'''

response = requests.delete(
    'https://demo.traccar.org/api/permissions',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "userId": 0,
  "deviceId": 0,
  "groupId": 0,
  "geofenceId": 0,
  "notificationId": 0,
  "calendarId": 0,
  "attributeId": 0,
  "driverId": 0,
  "managedUserId": 0,
  "commandId": 0
}

Body

application/json

This is a permission map that contain two object indexes. It is used to link/unlink objects. Order is important. Example: { deviceId:8, geofenceId: 16 }

userIdinteger<int64>

User id, can be only first parameter

deviceIdinteger<int64>

Device id, can be first parameter or second only in combination with userId

groupIdinteger<int64>

Group id, can be first parameter or second only in combination with userId

geofenceIdinteger<int64>

Geofence id, can be second parameter only

notificationIdinteger<int64>

Notification id, can be second parameter only

calendarIdinteger<int64>

Calendar id, can be second parameter only and only in combination with userId

attributeIdinteger<int64>

Computed attribute id, can be second parameter only

driverIdinteger<int64>

Driver id, can be second parameter only

managedUserIdinteger<int64>

User id, can be second parameter only and only in combination with userId

commandIdinteger<int64>

Saved command id, can be second parameter only

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Link multiple Objects in a single request

POST

https://demo.traccar.org/api/permissions/bulk

Link multiple Objects in a single request

curl -X POST 'https://demo.traccar.org/api/permissions/bulk' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]'

const body = `[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]`;

const response = await fetch('https://demo.traccar.org/api/permissions/bulk', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]'''

response = requests.post(
    'https://demo.traccar.org/api/permissions/bulk',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]

Body

application/json

Array<Permission>

Show child attributes

This is a permission map that contain two object indexes. It is used to link/unlink objects. Order is important. Example: { deviceId:8, geofenceId: 16 }

userIdinteger<int64>

User id, can be only first parameter

deviceIdinteger<int64>

Device id, can be first parameter or second only in combination with userId

groupIdinteger<int64>

Group id, can be first parameter or second only in combination with userId

geofenceIdinteger<int64>

Geofence id, can be second parameter only

notificationIdinteger<int64>

Notification id, can be second parameter only

calendarIdinteger<int64>

Calendar id, can be second parameter only and only in combination with userId

attributeIdinteger<int64>

Computed attribute id, can be second parameter only

driverIdinteger<int64>

Driver id, can be second parameter only

managedUserIdinteger<int64>

User id, can be second parameter only and only in combination with userId

commandIdinteger<int64>

Saved command id, can be second parameter only

Response

204No Content

No Content

400Bad Request

Bad request

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Unlink multiple Objects in a single request

DELETE

https://demo.traccar.org/api/permissions/bulk

Unlink multiple Objects in a single request

curl -X DELETE 'https://demo.traccar.org/api/permissions/bulk' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]'

const body = `[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]`;

const response = await fetch('https://demo.traccar.org/api/permissions/bulk', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]'''

response = requests.delete(
    'https://demo.traccar.org/api/permissions/bulk',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

[
  {
    "userId": 0,
    "deviceId": 0,
    "groupId": 0,
    "geofenceId": 0,
    "notificationId": 0,
    "calendarId": 0,
    "attributeId": 0,
    "driverId": 0,
    "managedUserId": 0,
    "commandId": 0
  }
]

Body

application/json

Array<Permission>

Show child attributes

This is a permission map that contain two object indexes. It is used to link/unlink objects. Order is important. Example: { deviceId:8, geofenceId: 16 }

userIdinteger<int64>

User id, can be only first parameter

deviceIdinteger<int64>

Device id, can be first parameter or second only in combination with userId

groupIdinteger<int64>

Group id, can be first parameter or second only in combination with userId

geofenceIdinteger<int64>

Geofence id, can be second parameter only

notificationIdinteger<int64>

Notification id, can be second parameter only

calendarIdinteger<int64>

Calendar id, can be second parameter only and only in combination with userId

attributeIdinteger<int64>

Computed attribute id, can be second parameter only

driverIdinteger<int64>

Driver id, can be second parameter only

managedUserIdinteger<int64>

User id, can be second parameter only and only in combination with userId

commandIdinteger<int64>

Saved command id, can be second parameter only

Response

204No Content

No Content

400Bad Request

Bad request

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey