Get query spec results

GetAssessmentQuerySpecResult Returns the total count of results for a query specification.

The response will include a number_value representing the total number of results.

POST/api/v1/assessments/query_spec:result

Body

application/json

query_typev1AssessmentQueryType (enum)

SYSTEM_CREATEDSOURCE_TO_DESTINATIONDESTINATION_NODES

source_node_typesv1NodeSpecCollection (object)

destination_node_typesv1NodeSpecCollection (object)

required_intermediate_node_typesv1NodeSpecCollection (object)

avoided_intermediate_node_typesv1NodeSpecCollection (object)

raw_permissionsA collection of raw permission names

effective_permissionsv1EffectivePermissionCollection (object)

customized_variablesarray of v1CreateAssessmentQueryVariableRequest (object)

no_relationuse relates_to_exp

snapshot_idstring (uint64)

node_relationship_typeapi_protosv1NodeRelationshipType (enum)

EFFECTIVE_ACCESSCONFIGURED

relates_to_expA RelatesToExpression E evaluates as "true if source has a path to E; otherwise false". for E = { specs: [A, B, ...], child_expressions: [X, Y, ...], operator, not, }, "source has a path to E" is defined as: - if operator = AND (default): "source has a path to ALL of (A,B, ..., X, Y, ...), i.e. A AND B AND ... AND X AND Y AND ..." - if operator = OR: "source has a path to ANY of (A,B, ..., X, Y, ...), i.e. A OR B OR ... OR X OR Y OR ..." - if not = true, boolean invert the result above

path_summary_node_typesv1NodeSpecCollection (object)

all_entity_conditionNodeSpecCollectionConditionExpression (object)

path_summary_count_conditionsv1CountConditionCollection (object)

result_value_typev1AssessmentQueryResultValueType (enum)

AssessmentQueryResultValueType determines which of the fields (values or path_values) will be populated in the resulting AssessmentQueryNodesResponse message. UNDEFINED is a valid selection and is intended for backward compatibility. When UNDEFINED is selected, the actual result value type will be determined by the backend (BE).

• UNDEFINED: Valid selection and intended for backward compatibility, result type determined by BE
• SOURCE_NODES_WITH_COUNTS: Returns populated values field containing source nodes and their destination counts
• SOURCE_AND_DESTINATION_NODES: Returns path_values with source and destination nodes, excluding path summary.
• PATHS: Returns path_values along with path summary.

UNDEFINEDSOURCE_NODES_WITH_COUNTSSOURCE_AND_DESTINATION_NODESPATHS

page_sizestring (int64)

The maximum number of results to be returned. Fewer results may be returned even when more pages exist.

page_tokenstring

The token specifying the specific page of results to retrieve.

Response

200401403404500502503

A successful response.

Body

application/json

result_typestring

number_valuestring (int64)

timestamp_valuestring

nodes_valueAssessmentQueryResultResponseNodes (object)

Request

JavaScriptCurl

const response = await fetch('/api/v1/assessments/query_spec:result', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result_type": "text",
  "number_value": "text",
  "timestamp_value": "text",
  "nodes_value": {
    "values": [
      {
        "id": "text",
        "type": "text",
        "permissions": [],
        "engagement_access_stats": {
          "total_count": "text",
          "accessed_count": "text"
        },
        "access_stats": {
          "last_used": "2024-04-30T14:42:19.681Z",
          "concrete_permissions": [
            "text"
          ],
          "canonical_permissions": [
            "text"
          ]
        },
        "destination_node_ids": [
          "text"
        ],
        "risk_level": "NONE",
        "raw_permissions": [
          "text"
        ],
        "effective_permissions": [
          "text"
        ]
      }
    ],
    "next_page_token": "text",
    "has_more": false
  }
}

Sample request:

curl -X 'POST' \
"$BASE_URL/api/v1/assessments/query_spec:result" \
-H "authorization: Bearer $VEZA_TOKEN" \
--data-raw '{
  "query_type": "SOURCE_TO_DESTINATION",
  "source_node_types": {
    "nodes": [
      {
        "node_type": "OktaUser",
        "tags": [],
        "conditions": [],
        "condition_expression": null,
        "node_id": "",
        "excluded_tags": [],
        "count_conditions": [],
        "direct_relationship_only": false,
        "node_type_grouping_constraint": null
      }
    ],
    "nodes_operator": "AND"
  },
  "destination_node_types": null,
  "required_intermediate_node_types": null,
  "avoided_intermediate_node_types": null,
  "raw_permissions": null,
  "effective_permissions": null,
  "customized_variables": [],
  "no_relation": false,
  "snapshot_id": "0",
  "access_filter": null,
  "node_relationship_type": "EFFECTIVE_ACCESS",
  "relates_to_exp": {
    "specs": [
      {
        "node_types": {
          "nodes": [
            {
              "node_type": "SnowflakeRole",
              "tags": [],
              "conditions": [],
              "condition_expression": {
                "specs": [
                  {
                    "fn": "EQ",
                    "property": "id",
                    "value": "dn44266.us-east-2.aws.snowflakecomputing.com/role/BILLING",
                    "not": false,
                    "value_property_name": "",
                    "value_property_from_other_node": false
                  }
                ],
                "child_expressions": [],
                "operator": "AND",
                "not": false
              },
              "node_id": "",
              "excluded_tags": [],
              "count_conditions": [],
              "direct_relationship_only": false,
              "node_type_grouping_constraint": null
            }
          ],
          "nodes_operator": "AND"
        },
        "required_intermediate_node_types": null,
        "avoided_intermediate_node_types": null,
        "raw_permissions": null,
        "effective_permissions": {
          "values": [],
          "operator": "OR"
        },
        "no_relation": false,
        "direction": "ANY_DIRECTION"
      }
    ],
    "child_expressions": [
      {
        "specs": [
          {
            "node_types": {
              "nodes": [
                {
                  "node_type": "SnowflakeRole",
                  "tags": [],
                  "conditions": [],
                  "condition_expression": {
                    "specs": [
                      {
                        "fn": "EQ",
                        "property": "id",
                        "value": "dn44266.us-east-2.aws.snowflakecomputing.com/role/AUDITOR",
                        "not": false,
                        "value_property_name": "",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "operator": "AND",
                    "not": false
                  },
                  "node_id": "",
                  "excluded_tags": [],
                  "count_conditions": [],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": null
                }
              ],
              "nodes_operator": "AND"
            },
            "required_intermediate_node_types": null,
            "avoided_intermediate_node_types": null,
            "raw_permissions": null,
            "effective_permissions": {
              "values": [],
              "operator": "OR"
            },
            "no_relation": false,
            "direction": "ANY_DIRECTION"
          },
          {
            "node_types": {
              "nodes": [
                {
                  "node_type": "SnowflakeRole",
                  "tags": [],
                  "conditions": [],
                  "condition_expression": {
                    "specs": [
                      {
                        "fn": "EQ",
                        "property": "id",
                        "value": "dn44266.us-east-2.aws.snowflakecomputing.com/role/ROLE_A",
                        "not": false,
                        "value_property_name": "",
                        "value_property_from_other_node": false
                      }
                    ],
                    "child_expressions": [],
                    "operator": "AND",
                    "not": false
                  },
                  "node_id": "",
                  "excluded_tags": [],
                  "count_conditions": [],
                  "direct_relationship_only": false,
                  "node_type_grouping_constraint": null
                }
              ],
              "nodes_operator": "AND"
            },
            "required_intermediate_node_types": null,
            "avoided_intermediate_node_types": null,
            "raw_permissions": null,
            "effective_permissions": {
              "values": [],
              "operator": "OR"
            },
            "no_relation": false,
            "direction": "ANY_DIRECTION"
          }
        ],
        "child_expressions": [],
        "operator": "OR",
        "not": false,
        "and_op_type": "INFERRED"
      }
    ],
    "operator": "AND",
    "not": false,
    "and_op_type": "SOURCE_INTERSECT"
  },
  "path_summary_node_types": null,
  "all_entity_condition": null,
  "page_size": "0",
  "page_token": ""
}'

Sample response:

The response will contain a number_value of total results:

{
  "number_value": 97
}