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

Авторизация API 1.6.0

Методы пользователей API и получение token.

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

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

Метод POST /login возвращает token. Полученный token передается в заголовке Authorization: Bearer <token> во всех последующих авторизованных запросах.

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

МетодПуть
GET/auth_users
GET/auth_users/{login}
POST/auth_users
POST/login
PUT/auth_users/{login}
DELETE/auth_users/{login}

GET /auth_users​

Раздел: Авторизация.

Возвращает список всех профилей входа (Get all authorization users).

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

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

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

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

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/auth_users"
  }
}

GET /auth_users/{login}​

Раздел: Авторизация.

Возвращает список настроек конкретного пользователя в соответствии с указанным значением в “login”.

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

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

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

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

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/auth_users/{login}"
  }
}

POST /auth_users​

Раздел: Авторизация.

Добавляет нового пользователя в систему.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/auth_users" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "login": "operator-api",
  "password": "<password>",
  "role": "admin"
}'

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

{
  "login": "operator-api",
  "password": "<password>",
  "role": "admin"
}

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

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

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

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

POST /login​

Раздел: Авторизация.

Получение token авторизации для последующих запросов к API.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/login" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "login": "api-user",
  "password": "<password>"
}'

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

{
  "login": "api-user",
  "password": "<password>"
}

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

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

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

{
  "user": {
    "login": "api-user",
    "role": "admin",
    "exp": 600
  },
  "token": "<token>"
}

PUT /auth_users/{login}​

Раздел: Авторизация.

Позволяет отредактировать добавленного пользователя.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/auth_users/{login}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "login": "operator-api",
  "password": "<password>",
  "role": "admin"
}'

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

{
  "login": "operator-api",
  "password": "<password>",
  "role": "admin"
}

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

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

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

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

DELETE /auth_users/{login}​

Раздел: Авторизация.

Позволяет удалить добавленного пользователя.

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

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

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

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

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

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