GET /api/usergroups
List all user groups

Params

Param name Description
search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String


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

Params

Param name Description
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..


POST /api/usergroups
Create a user group

Params

Param name Description
usergroup
required

Validations:

  • Hash

usergroup[name]
required

Validations:

  • String

usergroup[admin]
optional , nil allowed

is an admin user group

Validations:

  • boolean

usergroup[user_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


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

Params

Param name Description
id
required

Validations:

  • String

usergroup
required

Validations:

  • Hash

usergroup[name]
optional

Validations:

  • String

usergroup[admin]
optional , nil allowed

is an admin user group

Validations:

  • boolean

usergroup[user_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

usergroup[role_ids]
optional , nil allowed

Validations:

  • Must be an array of any type


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

Params

Param name Description
id
required

Validations:

  • String