Get Azure entity

Retrieves entity information for the given Azure object ID. If related_entity_type parameter is not set, this endpoint will return information about a single entity. Using the counts boolean parameter will further modify the response. If related_entity_type parameter is set, this endpoint will return information about entities related to a single entity. The type parameter will morph the response data structure. The list value for the type parameter also accepts skip and limit parameters.

GET /api/v2/azure/{entity_type}

Get Azure entity

cURL

curl --request GET \
  --url https://bloodhound.specterops.io/openapi.json/api/v2/azure/{entity_type} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "kind": "<string>",
    "properties": {}
  }
}

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.

Path Parameters

entity_type · string · required

Entity Type

Query Parameters

object_id · string · required

The object ID of the entity being operated on.

counts · boolean

Returns related entity counts. Does not work with related_entity_type parameter.

related_entity_type · string

Flags the query to return related entity information based on the type passed.

type · enum<string> · default: list

The type of return data expected. Only works with related_entity_type parameter.

Available options: list, graph

skip · integer

This query parameter is used for determining the number of objects to skip in pagination. Only compatible with related_entity_type and type=list

The number of items to skip in a paginated response.

Required range: x >= 0

limit · integer · default: 100

This query parameter is used for setting an upper limit of objects returned in paginated responses. Only compatible with related_entity_type and type=list

The limit of results requested by the client.

Required range: x >= 0

Response

200

application/json

This endpoint returns a polymorphic response dependent on the query parameters passed. Three different response schemas are possible:

• entity schema is used when related_entity_type is not set. Additional 'count' properties are dependent on the type of entity being queried.
• related-list schema is used when related_entity_type is set and type parameter is either list or not set (it is the default), and it supports pagination.
• related-graph schema is used when related_entity_type is set and type=graph.

entity

related-list

related-graph

This response is used when related_entity_type is not set. It returns information about a single node. All node types will return with the basic node fields, but the additional count properties are dependent on the kind of node returned. Setting counts=true will populate those count details at the cost of performance.

data · object

Show child attributes