GET /api/usergroups
Список всех групп пользователей

Параметры

Имя параметра Описание
search
необязательно

отфильтровать результаты

Validations:

  • Must be String

order
необязательно

отсортировать результаты

Validations:

  • Must be String

page
необязательно

постраничный вывод

Validations:

  • Must be String

per_page
необязательно

количество записей на запрос

Validations:

  • Must be String


GET /api/usergroups/:id
Показать группу пользователя

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/usergroups
Создать группу пользователя

Параметры

Имя параметра Описание
usergroup
обязательно

Validations:

  • Must be a Hash

usergroup[name]
обязательно

Validations:

  • Must be String

usergroup[admin]
необязательно , nil разрешен

is an admin user group

Validations:

  • Must be 'true' or 'false' or '1' or '0'

usergroup[user_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

usergroup[role_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type


PUT /api/usergroups/:id
Изменить группу пользователя

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be String

usergroup
обязательно

Validations:

  • Must be a Hash

usergroup[name]
необязательно

Validations:

  • Must be String

usergroup[admin]
необязательно , nil разрешен

is an admin user group

Validations:

  • Must be 'true' or 'false' or '1' or '0'

usergroup[user_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

usergroup[role_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type


DELETE /api/usergroups/:id
Удалить группу пользователя

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be String