Перейти к основному содержимому

Профили доступа API 1.5.0

Профили доступа и правила доступа.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.5.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/access_profiles/
GET/access_profiles/{uuid}
POST/access_profiles/
PUT/access_profiles/{uuid}
DELETE/access_profiles/{uuid}

GET /access_profiles/​

Раздел: Профили доступа.

Возвращает список всех добавленных профилей доступа.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/access_profiles/" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/access_profiles/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/access_profiles/"
  }
}

GET /access_profiles/{uuid}​

Раздел: Профили доступа.

Возвращает настройки конкретного профиля доступа.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/access_profiles/{uuid}"
  }
}

POST /access_profiles/​

Раздел: Профили доступа.

Добавляет новый профиль доступа.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/access_profiles/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Сотрудники офиса",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}'

Пример тела запроса​

{
  "name": "Сотрудники офиса",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/access_profiles/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /access_profiles/{uuid}​

Раздел: Профили доступа.

Редактирует существующий профиль доступа.

Пример запроса​

curl -k -X PUT "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "Сотрудники офиса",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}'

Пример тела запроса​

{
  "name": "Сотрудники офиса",
  "access_points": [
    "<access_point_uuid>"
  ],
  "schedule_uuid": "<schedule_uuid>"
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /access_profiles/{uuid}​

Раздел: Профили доступа.

Удаляет существующий профиль доступа.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/access_profiles/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}