AWaws-samples
User Management

Retrieve all LDAP users

Changed on

Returns a list of all users from the configured LDAP directory (OpenLDAP or Active Directory). Supports optional typeahead mode via the q parameter.

get/api/ldap/users

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:john

Typeahead filter (minimum 2 characters). When provided, returns a small filtered list with username and display_name 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 users

successboolean
messageobject

Dictionary of username to LDAP DN mappings

Example response

{
  "success": true,
  "message": {
    "john.doe": "cn=john.doe,ou=people,dc=soca,dc=local",
    "jane.smith": "cn=jane.smith,ou=people,dc=soca,dc=local"
  }
}

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