Examples

GET /api/usergroups/1/external_usergroups
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "id": 1,
      "name": "external_usergroup3",
      "auth_source_ldap": {
        "id": 980190963,
        "type": "AuthSourceLdap",
        "name": "auth_source_ldap_63"
      }
    }
  ]
}

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