GET /api/usergroups/:usergroup_id/external_usergroups
List all external user groups for user group

GET /api/auth_source_ldaps/:auth_source_ldap_id/external_usergroups
List all external user groups for LDAP authentication source

Examples

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

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