GET /api/usergroups
List all user groups

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String

GET /api/usergroups/:id
Show a user group

Params

Param name Description
id
required

Value: 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
Create a user group

Params

Param name Description
usergroup
required

Value: Must be a Hash
usergroup[name]
required

Value: Must be String
usergroup[user_ids]
optional , nil allowed

Value: Must be an array of any type
usergroup[usergroup_ids]
optional , nil allowed

Value: Must be an array of any type
usergroup[role_ids]
optional , nil allowed

Value: Must be an array of any type

PUT /api/usergroups/:id
Update a user group

Params

Param name Description
id
required

Value: Must be String
usergroup
required

Value: Must be a Hash
usergroup[name]
optional

Value: Must be String
usergroup[user_ids]
optional , nil allowed

Value: Must be an array of any type
usergroup[usergroup_ids]
optional , nil allowed

Value: Must be an array of any type
usergroup[role_ids]
optional , nil allowed

Value: Must be an array of any type

DELETE /api/usergroups/:id
Delete a user group

Params

Param name Description
id
required

Value: Must be String