Examples

POST /api/usergroups/3-usergroup324/external_usergroups
{
  "external_usergroup": {
    "name": "foremanusergroup",
    "auth_source_id": 980190965
  }
}
201
{
  "id": 3,
  "name": "foremanusergroup",
  "auth_source_ldap": {
    "id": 980190965,
    "type": "AuthSourceLdap",
    "name": "auth_source_ldap_65"
  }
}

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

external_usergroup
Required

External user group information

Validations:

  • Must be a Hash

external_usergroup[name]
Required

External user group name

Validations:

  • Must be a String

external_usergroup[auth_source_id]
Required

ID of linked authentication source

Validations:

  • Must be a number.