Перейти к содержанию

Управление правами доступа

На этой странице представлены описания методов API для управления правами доступа к устройствам для учетных записей техников и отделов из раздела Команда.

Управление доступом техников

Права доступа техника

Получить список прав, назначенных учетной записи техника или отправленного приглашению, можно с помощью метода team/member/access/list.

Запрос:
GET /v1/team/member/access/list
  ?email=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY
curl -G "https://api.pro32connect.ru/v1/team/member/access/list" \
  --data-urlencode "email=<string>" \
  -H "X-Api-Key: YOUR_API_KEY"
Параметр Тип Описание
email string Адрес электронной почты учетной записи техника или отправленного приглашения.
Ответ:
Пример ответа
Данные ответа
{
    "data": {
        "id": 1002,
        "email": "john.miller@gmail.com",
        "roles": [ {
            "id": 2001,
            "group_id": 1001
        }, {
            "id": 2002,
            "agent_id": 1002
        }, {
            "id": 2003,
            "default": true
        } ]
    },
    "status": 0
}
Название Тип Описание
id number Внутренний идентификатор учетной записи техника или отправленного приглашения.
email string Адрес электронной почты.
roles array Список назначенных прав.
roles[].id number Внутренний идентификатор роли.
roles[].agent_id number Внутренний идентификатор устройства, к которому применяется право.

ℹ Присутствует только при назначении роли с областью действия agent.
roles[].group_id number Внутренний идентификатор группы устройств, к которой применяется право.

ℹ Присутствует только при назначении роли с областью действия group.

Добавление права доступа технику

Предоставить учетной записи техника или отправленного приглашения доступ к устройству в разделе Постоянный доступ, разделу Быстрая поддержка или другой функции команды можно с помощью метода team/member/access/add.

Запрос:
POST /v1/team/member/access/add
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "email": <string>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}
curl -X POST "https://api.pro32connect.ru/v1/team/member/access/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'
Параметр Тип Описание
email string Адрес электронной почты учетной записи техника или отправленного приглашения.
role_id number Внутренний идентификатор назначаемой роли.
agent_id number Внутренний идентификатор устройства. Обязателен при назначении роли с областью действия agent.
group_id number Внутренний идентификатор группы устройств. Обязателен при назначении роли с областью действия group.
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус выполнения. Возможные значения:
  • 0 — Право успешно назначено
  • 1 — Некорректные данные запроса
  • 6 — Недостаточно прав

Удаление прав доступа у техника

Удалить право доступа у учетной записи техника или отправленного приглашения можно с помощью метода team/member/access/remove.

Запрос:
POST /v1/team/member/access/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "email": <string>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}
curl -X POST "https://api.pro32connect.ru/v1/team/member/access/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "email": <string>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'
Параметр Тип Описание
email string Адрес электронной почты учетной записи техника или отправленного приглашения.
role_id number Внутренний идентификатор удаляемой роли.
agent_id number Внутренний идентификатор устройства. Обязателен при удалении роли с областью действия agent.
group_id number Внутренний идентификатор группы устройств. Обязателен при удалении роли с областью действия group.
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус выполнения. Возможные значения:
  • 0 — Право успешно удалено
  • 1 — Некорректные данные запроса
  • 6 — Недостаточно прав

Управление доступом отделов

Права доступа отдела

Получить список прав, назначенных отделу, можно с помощью метода team/department/access/list.

Запрос:
GET /v1/team/department/access/list
  ?id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY
curl -G "https://api.pro32connect.ru/v1/team/department/access/list" \
  --data-urlencode "id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"
Параметр Тип Описание
id number Внутренний идентификатор отдела.
Ответ:
Пример ответа
Данные ответа
{
    "data": {
        "id": 1002,
        "roles": [ {
            "id": 2001,
            "group_id": 1001
        }, {
            "id": 2002,
            "agent_id": 1002
        }, {
            "id": 2003
        } ]
    },
    "status": 0
}
Название Тип Описание
id number Внутренний идентификатор отдела.
roles array Список назначенных прав.
roles[].id number Внутренний идентификатор роли.
roles[].agent_id number Внутренний идентификатор устройства, к которому применяется право.

ℹ Присутствует только при назначении роли с областью действия agent.
roles[].group_id number Внутренний идентификатор группы устройств, к которой применяется право.

ℹ Присутствует только при назначении роли с областью действия group.

Добавление права доступа отделу

Предоставить отделу доступ к устройству в разделе Постоянный доступ, разделу Быстрая поддержка или другой функции команды можно с помощью метода team/department/access/add.

Запрос:
POST /v1/team/department/access/add
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "department_id": <number>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}
curl -X POST "https://api.pro32connect.ru/v1/team/department/access/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "department_id": <number>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'
Параметр Тип Описание
department_id number Внутренний идентификатор отдела.
role_id number Внутренний идентификатор назначаемой роли.
agent_id number Внутренний идентификатор устройства. Обязателен при назначении роли с областью действия agent.
group_id number Внутренний идентификатор группы устройств. Обязателен при назначении роли с областью действия group.
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус выполнения. Возможные значения:
  • 0 — Право успешно назначено.
  • 1 — Некорректные данные запроса.
  • 2 — Внутренняя ошибка сервера.
  • 6 — Отдел не найден.
  • 8 — Недостаточно прав.

Удаление прав доступа у отдела

Удалить право доступа у отдела можно с помощью метода team/department/access/remove.

Запрос:
POST /v1/team/department/access/remove
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "department_id": <number>,
  "role_id": <number>,
  "agent_id": <number>,
  "group_id": <number>
}
curl -X POST "https://api.pro32connect.ru/v1/team/department/access/remove" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "department_id": <number>,
    "role_id": <number>,
    "agent_id": <number>,
    "group_id": <number>
  }'
Параметр Тип Описание
department_id number Внутренний идентификатор отдела.
role_id number Внутренний идентификатор удаляемой роли.
agent_id number Внутренний идентификатор устройства. Обязателен при удалении роли с областью действия agent.
group_id number Внутренний идентификатор группы устройств. Обязателен при удалении роли с областью действия group.
Ответ:
Пример ответа
Данные ответа
{
    "status": 0
}
Название Тип Описание
status number Статус выполнения. Возможные значения:
  • 0 — Право успешно удалено.
  • 1 — Некорректные данные запроса.
  • 6 — Недостаточно прав.