List asset group tag members by ID

List members of an asset group tag by ID

GET /api/v2/asset-group-tags/{asset_group_tag_id}/members

List asset group tag members by ID

cURL

curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/{asset_group_tag_id}/members \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 1,
  "skip": 1,
  "limit": 1,
  "data": {
    "members": [
      {
        "id": 123,
        "object_id": "<string>",
        "environment_id": "<string>",
        "primary_kind": "<string>",
        "name": "<string>",
        "properties": {},
        "source": 123
      }
    ]
  }
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

asset_group_tag_id · integer<int32> · required

ID of an asset group tag

Query Parameters

skip · integer

This query parameter is used for determining the number of objects to skip in pagination. The number of items to skip in a paginated response.

Required range: x >= 0

limit · integer

This query parameter is used for setting an upper limit of objects returned in paginated responses. The limit of results requested by the client.

Required range: x >= 0

environments · string[]

Environment IDs to filter response by

sort_by · string

Sortable columns are id, objectid, and name.

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

primary_kind · string

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

name · string

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

object_id · string

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

Response

200

application/json

OK

count · integer

The total number of results.

Required range: x >= 0

skip · integer

The number of items to skip in a paginated response.

Required range: x >= 0

limit · integer

The limit of results requested by the client.

Required range: x >= 0

data · object

Show child attributes