Users and access

Session

User session management

Fetch Session information

GET

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

Fetch Session information

curl -X GET 'https://demo.traccar.org/api/session'

const response = await fetch('https://demo.traccar.org/api/session', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://demo.traccar.org/api/session')
print(response.text)

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Parameters

tokenstringquery

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

404Not Found

Not found

Create a new Session

POST

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

Create a new Session

curl -X POST 'https://demo.traccar.org/api/session' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'email=string&password=%2A%2A%2A%2A%2A%2A%2A%2A'

const response = await fetch('https://demo.traccar.org/api/session', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: 'email=string&password=%2A%2A%2A%2A%2A%2A%2A%2A',
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/session',
    data='email=string&password=%2A%2A%2A%2A%2A%2A%2A%2A'.encode('utf-8'),
    headers={
        'Content-Type': 'application/x-www-form-urlencoded',
    },
)
print(response.text)

Request Body

{
  "email": "string",
  "password": "********"
}

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Body

application/x-www-form-urlencoded

emailstringrequired

passwordstring<password>required

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

401Unauthorized

Unauthorized

Close the Session

DELETE

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

Close the Session

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

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

const data = await response.text();

import requests

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

Response

204No Content

No Content

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Open a Session as another User

GET

https://demo.traccar.org/api/session/{id}

Admin or manager only. Establishes a session impersonating the specified user.

Open a Session as another User

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

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

const data = await response.text();

import requests

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

200

{
  "id": 0,
  "name": "string",
  "email": "string",
  "phone": "string",
  "readonly": true,
  "administrator": true,
  "map": "string",
  "latitude": 0,
  "longitude": 0,
  "zoom": 0,
  "password": "string",
  "coordinateFormat": "string",
  "disabled": true,
  "expirationTime": "2024-01-15T09:30:00Z",
  "deviceLimit": 0,
  "userLimit": 0,
  "deviceReadonly": true,
  "limitCommands": true,
  "fixedEmail": true,
  "poiLayer": "string",
  "attributes": {}
}

Parameters

idintegerrequiredpath

Response

200OKUser

Response fields application/json

idinteger<int64>

Unique user identifier

namestring

User display name

emailstring

Email address used for login and notifications

phonestring | null

Contact phone number for alerts

readonlyboolean

When true, the user cannot change settings

administratorboolean

Grants full administrative privileges when enabled

mapstring | null

Preferred default map layer for the user

latitudenumber

Default map center latitude for this user

longitudenumber

Default map center longitude for this user

zoominteger

Default map zoom level on login

passwordstring

Password for user authentication

coordinateFormatstring | null

Preferred coordinate display format

disabledboolean

Indicates whether the user account is disabled

expirationTimestring<date-time> | null

in ISO 8601 format. eg. 1963-11-22T18:30:00Z

deviceLimitinteger

Maximum number of devices the user can manage

userLimitinteger

Maximum number of subordinate users

deviceReadonlyboolean

Restricts user from modifying device attributes

limitCommandsboolean

Prevents user from sending unsupported commands

fixedEmailboolean

Locks the email field to avoid changes

poiLayerstring | null

External POI layer configured for the user

attributesobject

Additional custom user attributes

401Unauthorized

Unauthorized

404Not Found

Not found

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Generate Session Token

POST

https://demo.traccar.org/api/session/token

Generate Session Token

curl -X POST 'https://demo.traccar.org/api/session/token' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'expiration=2024-01-15T09%3A30%3A00Z'

const response = await fetch('https://demo.traccar.org/api/session/token', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: 'expiration=2024-01-15T09%3A30%3A00Z',
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/session/token',
    data='expiration=2024-01-15T09%3A30%3A00Z'.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/x-www-form-urlencoded',
    },
)
print(response.text)

Request Body

{
  "expiration": "2024-01-15T09:30:00Z"
}

200

string

Body

application/x-www-form-urlencoded

expirationstring<date-time>

Response

200OKstring

Token string

Response fields text/plain

string

400Bad Request

Bad request

401Unauthorized

Unauthorized

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Revoke Session Token

POST

https://demo.traccar.org/api/session/token/revoke

Revoke Session Token

curl -X POST 'https://demo.traccar.org/api/session/token/revoke' \
  -H 'Authorization: Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-raw 'token=string'

const response = await fetch('https://demo.traccar.org/api/session/token/revoke', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
    'Content-Type': 'application/x-www-form-urlencoded',
  },
  body: 'token=string',
});

const data = await response.text();

import requests

response = requests.post(
    'https://demo.traccar.org/api/session/token/revoke',
    data='token=string'.encode('utf-8'),
    headers={
        'Authorization': 'Basic WU9VUl9VU0VSTkFNRTpZT1VSX1BBU1NXT1JE',
        'Content-Type': 'application/x-www-form-urlencoded',
    },
)
print(response.text)

Request Body

{
  "token": "string"
}

Body

application/x-www-form-urlencoded

tokenstringrequired

Response

204No Content

No Content

400Bad Request

Bad request

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Begin OpenID Connect authentication

GET

https://demo.traccar.org/api/session/openid/auth

Begin OpenID Connect authentication

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

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

const data = await response.text();

import requests

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

Response

303See Other

Redirect to OpenID Connect identity provider

400Bad Request

OpenID Connect is not configured

default

Unexpected error

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

OpenID Callback

GET

https://demo.traccar.org/api/session/openid/callback

OpenID Callback

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

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

const data = await response.text();

import requests

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

Response

303See Other

Successful authentication, redirect to homepage

400Bad Request

Invalid or expired callback parameters

default

Unexpected error

Authorization

BasicAuthhttp (basic)

ApiKeyhttp (bearer)

Docs by Sourcey