List of temporary users

Getting a list of temporary users

Returns a list of temporary users.

GET /api/admin/v1/special-users

Method parameters

int search, search by temporary user name

int per_page, number of items per pagination page. Default is 25

int page, pagination page number

200 OK

Successful response

JSON

{
    "id": 66,
    "name": "user",
    "login": "user@mail.com",
    "created_at": "2022-01-03 18:29:58",
    "updated_at": "2022-05-12 17:26:32",
    "expired_at": "2022-05-13 17:25:12",
    "cameras": [
        {
            "id": 769,
            "group_id": 103,
            "status": "active",
            "type": "media_server_v2",
            "pretty_text": "Cameras",
            "short_pretty": "Cameras",
            "start_at": "2022-05-11 17:26:32",
            "created_at": "2022-01-28 02:41:21",
            "name": "Camera 1",
            "can_edit": true,
            "origin": null,
            "group_type": "public",
            "shared_from": null,
            "ip": "mediaserver1.vms.local",
            "lat": null,
            "lng": null,
            "azimuth": null,
            "is_sensitive": 0,
            "is_public": 0,
            "count_issues": 0,
            "source": "manual",
            "archive_storage_days": 1,
            "is_archive_recording": true,
            "archive_recording_type": "fulltime",
            "is_increased_reconnect": 0,
            "is_sound_enabled": false,
            "is_bridge": false
        }
    ],
    "is_licence_limit_reached": false,
    "permissions": [
        {
            "id": 240,
            "name": "analytic-cases-camera-obstacle",
            "display_name": "Name",
            "group": "Group"
        }
    ],
    "ptz_priority": 10,
    "access_token_id": null,
    "analytic_license": [
        {
            "type": "analytic_l1",
            "type_pretty": "LIC-XXXX-YY-L1",
            "all": 100,
            "free": 100,
            "used": 0
        },
        {
            "type": "analytic_l2",
            "type_pretty": "LIC-XXXX-YY-L2",
            "all": 100,
            "free": 100,
            "used": 0
        },
        {
            "type": "analytic_l3",
            "type_pretty": "LIC-XXXX-YY-L3",
            "all": 100,
            "free": 100,
            "used": 0
        }
    ]
}

401 Unauthorized

Authorization token is not provided or is invalid. Obtaining a token

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/special-users' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "search": 0,
    "per_page": 0,
    "page": 0
}'

PHP

$data = array (
  'search' => 0,
  'per_page' => 0,
  'page' => 0,
);
$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/special-users', false, $context);