Usergroups

>>>

GET /api/usergroups
List all user groups.

Params

Param Name Description
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

number of entries per request

Validations:

  • Must be a String
search
Optional

filter results

Validations:

  • Must be a String
order
Optional

sort results

Validations:

  • Must be a 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 a String
>>>

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

Params

Param Name Description
id
Required

Validations:

  • Must be a String
usergroup
Required

Validations:

  • Must be a Hash
usergroup[name]
Optional

Validations:

  • Must be a String
>>>

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

Params

Param Name Description
id
Required

Validations:

  • Must be a String