POST /api/usergroups
Create a user group

Examples

POST /api/usergroups
{
  "usergroup": {
    "name": "test_usergroup",
    "usergroup_ids": [
      5
    ]
  }
}
201
{
  "admin": false,
  "created_at": "2019-11-07 08:35:24 UTC",
  "updated_at": "2019-11-07 08:35:24 UTC",
  "name": "test_usergroup",
  "id": 6,
  "external_usergroups": [],
  "usergroups": [
    {
      "name": "usergroup15",
      "id": 5,
      "created_at": "2019-11-07 08:35:24 UTC",
      "updated_at": "2019-11-07 08:35:24 UTC"
    }
  ],
  "users": [],
  "roles": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
usergroup
required

Validations:

  • Must be a Hash
usergroup[name]
required

Validations:

  • Must be a String
usergroup[admin]
optional , nil allowed

is an admin user group

Validations:

  • Must be one of: true, false, 1, 0.
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