POST /api/usergroups/:usergroup_id/external_usergroups
Create an external user group linked to a user group

Examples

POST /api/usergroups/2-usergroup4/external_usergroups
{
  "external_usergroup": {
    "name": "foremanusergroup",
    "auth_source_id": 980190964
  }
}
201
{
  "id": 2,
  "name": "foremanusergroup",
  "auth_source_ldap": {
    "id": 980190964,
    "type": "AuthSourceLdap",
    "name": "auth_source_ldap_3"
  }
}

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.