BloodHound Users
Community
Enterprise

List Users Minimal

Changed on

Returns all BloodHound user details without any sensitive data.

get/api/v2/bloodhound-users-minimal

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/bloodhound-users-minimal
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are id, first_name, last_name and email_address.

first_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

last_namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

email_addressstring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

idstring

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

Response

OK

Changes

  • f87a90d5a2d0Revision changes
    • breaking

      added the pattern ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ to the query request parameter id

    • info

      for the query request parameter id, the format was generalized from uuid to no format

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter email_address

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter first_name

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter last_name