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://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-tenant.bloodhoundenterprise.io/api/v2/azure/{entity_type}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

{
  "http_status": 400,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The JSON payload could not be unmarshalled."
    }
  ]
}

{
  "http_status": 401,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "login",
      "message": "Unauthorized"
    }
  ]
}

{
  "http_status": 403,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "You do not have permission to access this resource"
    }
  ]
}

{
  "http_status": 404,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The requested client could not be found."
    }
  ]
}

{
  "http_status": 429,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "middleware",
      "message": "Too many requests. Please try again later."
    }
  ]
}

{
  "http_status": 500,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The request could not be handled due to an unexpected database error."
    }
  ]
}

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

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