Создание временного пользователя

Создание временного пользователя.

При создании пользователей с большим количеством камер, необходимо будет послать несколько запросов.

В одном запросе может быть до 500 камер.

Описание смотри ниже в описании параметра.

POST api/admin/v1/special-users

Параметры метода

string name, имя

string login, уникальный логин среди всех пользователей

string password, пароль

string password_confirmation, повторный ввод пароля, чтобы убедиться, что пароль введен правильно

array permissions, массив id пермишенов

array cameras_to_attach, массив id камер, которые будут доступны пользователю. В запросе можно прислать максимум 500 элементов. Если нужно больше, то необходимо сразу после создания послать Обновление временного пользователя с остальными камерами

date expired_at, дата, до которой будет действовать временный пользователь

int ptz_priority, PTZ приоритет

200 OK

Возвращает объект временного пользователя

JSON

{
    "id": 117,
    "name": "user",
    "login": "user@mail.com",
    "created_at": "2022-05-11 18:40:46",
    "updated_at": "2022-05-11 18:40:46",
    "expired_at": null,
    "is_licence_limit_reached": false,
    "permissions": [
        {
            "id": 77,
            "name": "archives-preview-download",
            "display_name": "Сохранение скриншота камеры",
            "group": "Screenshots"
        },
        {
            "id": 149,
            "name": "packs-index",
            "display_name": "Просмотр списка групп медиасерверов",
            "group": "Группы медиасерверов"
        },
        {
            "id": 150,
            "name": "packs-show",
            "display_name": "Просмотр группы медиасервера",
            "group": "Группы медиасерверов"
        },
        {
            "id": 151,
            "name": "packs-store",
            "display_name": "Сохранение группы медиасерверов",
            "group": "Группы медиасерверов"
        },
        {
            "id": 152,
            "name": "packs-update",
            "display_name": "Обновление группы медиасервера",
            "group": "Группы медиасерверов"
        },
        {
            "id": 153,
            "name": "packs-destroy",
            "display_name": "Удаление группы медиасервера",
            "group": "Группы медиасерверов"
        }
    ],
    "ptz_priority": null,
    "admin_camera_groups": [],
    "dhcp_subnet_groups": [],
    "access_token_id": null
}

401 Unauthorized

Токен авторизации не передан или не валидный

402 Payment Required

Превышен лимит лицензий для выбранного кейса аналитики

422 Unprocessable Entity

Возвращает JSON объект с ошибкой. Валидация

JSON

{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

cURL

BASH

curl -k --request POST \
	--url 'https://your-domainapi/admin/v1/special-users' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "name": "string",
    "login": "string",
    "password": "string",
    "password_confirmation": "string",
    "permissions": [],
    "cameras_to_attach": [],
    "expired_at": "date",
    "ptz_priority": 0
}'

PHP

$data = array (
  'name' => 'string',
  'login' => 'string',
  'password' => 'string',
  'password_confirmation' => 'string',
  'permissions' => 
  array (
  ),
  'cameras_to_attach' => 
  array (
  ),
  'expired_at' => 'date',
  'ptz_priority' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domainapi/admin/v1/special-users', false, $context);