AWaws-samples
Group Management

Retrieve all LDAP groups

Changed on

Returns a list of all groups from the configured LDAP directory with their members. Supports optional typeahead mode via the q parameter.

get/api/ldap/groups

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Query parameters

qstring
Example:dev

Typeahead filter (minimum 2 characters). When provided, returns a small filtered list of matching group names instead of the full directory.

max_resultsinteger
Example:50

Maximum number of results to return in typeahead mode. Clamped to 1-200.

Response

Successfully retrieved all LDAP groups

successboolean
messageobject

Dictionary of group names to group information

Example response

{
  "success": true,
  "message": {
    "developers": {
      "group_dn": "cn=developers,ou=group,dc=soca,dc=local",
      "members": [
        "john.doe",
        "jane.smith"
      ]
    },
    "admins": {
      "group_dn": "cn=admins,ou=group,dc=soca,dc=local",
      "members": [
        "admin"
      ]
    }
  }
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the new optional query request parameter max_results

    • info

      added the new optional query request parameter q

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API