Get query nodes

GetAssessmentQueryNodes returns node details for entities in the query results, with a paginated response.

Please note that the total number of the results is not provided . To get a result count, use GetAssessmentQueryResult.

GET/api/v1/assessments/queries/{id}:nodes

Path parameters

id*string

Query parameters

Response

200401403404500502503

A successful response.

Body

application/json

valuesarray of v1AssessmentQueryNode (object)

path_valuesarray of v1AssessmentQueryNodePath (object)

next_page_tokenstring

The token to retrieve the next page of results. Note: you must rely on the value of has_more to determine if there are additional results as the next_page_token returned may not be empty even if has_more is false.

has_moreboolean

If true, more results are available.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/assessments/queries/{id}:nodes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "values": [
    {
      "id": "text",
      "type": "text",
      "destination_node_count": 0,
      "permissions": [],
      "engagement_access_stats": {
        "engagement_score": 0,
        "over_provisioned_score": 0,
        "total_count": "text",
        "accessed_count": "text"
      },
      "access_stats": {
        "last_used": "2024-12-19T06:46:29.996Z",
        "count": 0,
        "concrete_permissions": [
          "text"
        ],
        "canonical_permissions": [
          "text"
        ]
      },
      "destination_node_ids": [
        "text"
      ],
      "risk_level": "NONE",
      "raw_permissions": [
        "text"
      ],
      "effective_permissions": [
        "text"
      ],
      "destination_node_percentage_of_total": 0
    }
  ],
  "path_values": [
    {
      "source": {
        "id": "text",
        "type": "text",
        "destination_node_count": 0,
        "permissions": [],
        "engagement_access_stats": {
          "engagement_score": 0,
          "over_provisioned_score": 0,
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2024-12-19T06:46:29.996Z",
          "count": 0,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "destination_node_ids": [
          "text"
        ],
        "risk_level": "NONE",
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ],
        "destination_node_percentage_of_total": 0
      },
      "abstract_permissions": [
        "text"
      ],
      "concrete_permissions": [
        "text"
      ],
      "destination": {
        "id": "text",
        "type": "text",
        "destination_node_count": 0,
        "permissions": [],
        "engagement_access_stats": {
          "engagement_score": 0,
          "over_provisioned_score": 0,
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2024-12-19T06:46:29.996Z",
          "count": 0,
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "destination_node_ids": [
          "text"
        ],
        "risk_level": "NONE",
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ],
        "destination_node_percentage_of_total": 0
      },
      "path_summary_nodes": [
        {
          "id": "text",
          "type": "text",
          "destination_node_count": 0,
          "permissions": [],
          "engagement_access_stats": {
            "engagement_score": 0,
            "over_provisioned_score": 0,
            "total_count": "text",
            "accessed_count": "text"
          },
          "access_stats": {
            "last_used": "2024-12-19T06:46:29.996Z",
            "count": 0,
            "concrete_permissions": [
              "text"
            ],
            "canonical_permissions": [
              "text"
            ]
          },
          "destination_node_ids": [
            "text"
          ],
          "risk_level": "NONE",
          "raw_permissions": [
            "text"
          ],
          "effective_permissions": [
            "text"
          ],
          "destination_node_percentage_of_total": 0
        }
      ],
      "results_truncated": false
    }
  ],
  "next_page_token": "text",
  "has_more": false
}

Sample request:

curl -X 'GET' "$BASE_URL/api/v1/assessments/queries/06799e24-cd93-4509-94bc-f00b27ed5e3c:nodes" \
-H "authorization: Bearer $VEZA_TOKEN"

Sample response:

{
  "values": [
    {
      "id": "arn:aws:iam::877042069677:user/j.smith",
      "type": "AwsIamUser",
      "properties": {
        "aws_account_id": "877042069677",
        "datasource_id": "877042069677:awsiam",
        "name": "j.smith",
        "provider_id": "877042069677"
      },
      "destination_node_count": 1,
      "permissions": [],
      "engagement_access_stats": null,
      "access_stats": null,
      "destination_node_ids": [],
      "risk_level": "CRITICAL",
      "raw_permissions": [],
      "effective_permissions": []
    },
    {
      "id": "arn:aws:iam::877042069677:user/jsmith-lab-01",
      "type": "AwsIamUser",
      "properties": {
        "aws_account_id": "877042069677",
        "datasource_id": "877042069677:awsiam",
        "name": "jsmith-lab-01",
        "provider_id": "877042069677"
      },
      "destination_node_count": 1,
      "permissions": [],
      "engagement_access_stats": null,
      "access_stats": null,
      "destination_node_ids": [],
      "risk_level": "CRITICAL",
      "raw_permissions": [],
      "effective_permissions": []
    }
  ],
  "path_values": [],
  "next_page_token": "",
  "has_more": false
}