Usergroups

>>>

GET /api/usergroups
List all user groups

Examples

GET /api/usergroups
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "admin": false,
      "created_at": "2020-11-04 14:03:24 UTC",
      "updated_at": "2020-11-04 14:03:24 UTC",
      "name": "usergroup18",
      "id": 21
    }
  ]
}

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
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
name string
role string
role_id integer
>>>

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

Examples

GET /api/usergroups/26-usergroup22
200
{
  "admin": false,
  "created_at": "2020-11-04 14:03:24 UTC",
  "updated_at": "2020-11-04 14:03:24 UTC",
  "name": "usergroup22",
  "id": 26,
  "external_usergroups": [],
  "usergroups": [],
  "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
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

Examples

POST /api/usergroups
{
  "usergroup": {
    "name": "test_usergroup"
  }
}
201
{
  "admin": false,
  "created_at": "2020-11-04 14:03:23 UTC",
  "updated_at": "2020-11-04 14:03:23 UTC",
  "name": "test_usergroup",
  "id": 10,
  "external_usergroups": [],
  "usergroups": [],
  "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
>>>

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

User groups linked to external groups (LDAP) are automatically synced with these groups on update. Remember this synchronization will remove any LDAP users manually added to the Foreman user group. Only LDAP users in the external groups will remain. Internal users can be added or removed freely.

Examples

PUT /api/usergroups/11
{
  "usergroup": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 11,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

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
id
required

Validations:

  • Must be a String
usergroup
required

Validations:

  • Must be a Hash
usergroup[name]
optional

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
>>>

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

Examples

DELETE /api/usergroups/25-usergroup21
{
  "usergroup": {}
}
200
{
  "id": 25,
  "name": "usergroup21",
  "created_at": "2020-11-04T14:03:24.482Z",
  "updated_at": "2020-11-04T14:03:24.482Z",
  "admin": false
}

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
id
required

Validations:

  • Must be a String