BloodHound Users
Community
Enterprise

List Users

Changed on

Gets all BloodHound user details.

get/api/v2/bloodhound-users

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/bloodhound-users
  • 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 first_name, last_name, email_address, principal_name, last_login, created_at, updated_at.

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.

principal_namestring

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.

last_loginstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by updated_at value. See filter schema details for valid predicates.

Response

OK

Changes

  • bad196650496Revision changes
    • warning

      deleted the query request parameter deleted_at

  • 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