GET /api/usergroups
List all user groups

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be String

order
Optional

sort results

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

number of entries per request

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

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

Params

Param Name Description
usergroup
Required

Validations:

  • Must be a Hash

usergroup[name]
Required

Validations:

  • Must be String

usergroup[admin]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

is an admin user group

Validations:

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

usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type

usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be String

usergroup
Required

Validations:

  • Must be a Hash

usergroup[name]
Optional

Validations:

  • Must be String

usergroup[admin]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

is an admin user group

Validations:

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

usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type

usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type

usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be String