Роли

Каждому пользователю, зарегистрированному на платформе, присваивается некоторая роль. Она назначается ему в зависимости:

Роль может быть привязана к роду деятельности пользователя, если речь идет о взаимодействии с другими компаниями. Например, могут быть созданы и назначены такие роли, как аналитик, разработчик, руководитель. Могут быть назначены роли, сформированные в зависимости от расширения прав. Это могут быть, к примеру, оператор, администратор, владелец. Все зависит от поставленной задачи.

При работе с ролями через API платформы могут быть выполнены следующие стандартные операции:

  1. Получение списка ролей.
  2. Получение информации об одной роли.
  3. Создание новой роли.
  4. Изменение роли.
  5. Удаление роли.

Получение списка ролей

Для получения полного списка ролей, доступных пользователю, необходимо отправить запрос GET /api/v1/roles. В ответе будет получен массив объектов, каждый из которых представляет собой конфигурацию отдельной роли.

Запрос

GET /api/v1/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

BODY

Получение информации об одной роли

Для того чтобы получить конфигурацию конкретной роли, достаточно добавить префикс _id, указав ее идентификационный номер. В ответе будет получена требуемая конфигурация роли и результат выполнения запроса.

Запрос

GET /api/v1/roles/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

BODY

Создание новой роли

Для создания новой роли в теле запроса указываются все поля и их значения, которые являются обязательными для любой роли. В том числе задаются права, которыми должен обладать пользователь с данной ролью.

Запрос

POST /api/v1/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

BODY

Ответ

HTTP/1.1 200 OK

BODY

Изменение роли

При изменении значений полей в конфигурации роли применяется и отправляется запрос PATCH /api/v1/roles/:id.

Запрос

PATCH /api/v1/roles/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

BODY

Ответ

HTTP/1.1 200 OK

BODY

Удаление роли

Для того чтобы удалить роль, необходимо отправить запрос DELETE /api/v1/roles/:id.

Запрос

DELETE /api/v1/roles/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

BODY