PUT /api/usergroups/:usergroup_id/external_usergroups/:id
Update external user group

Examples

PUT /api/usergroups/7/external_usergroups/7
{
  "external_usergroup": {
    "name": "foremanusergroup"
  }
}
200
{
  "id": 7,
  "name": "foremanusergroup",
  "auth_source_ldap": {
    "id": 980190969,
    "type": "AuthSourceLdap",
    "name": "auth_source_ldap_45"
  }
}

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

ID or name of user group

Validations:

  • Must be a String
id
required

ID or name of external user group

Validations:

  • Must be a String
external_usergroup
required

External user group information

Validations:

  • Must be a Hash
external_usergroup[name]
optional

External user group name

Validations:

  • Must be a String
external_usergroup[auth_source_id]
optional

ID of linked authentication source

Validations:

  • Must be a number.