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_69"
  }
}

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

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.