Update a query

UpdateAssessmentQuery updates an existing saved query by id, with the provided full body. Partial updates are not currently supported.

PUT/api/v1/assessments/queries/{id}

Path parameters

id*string

Body

application/json

namestring

descriptionstring

raw_permissionsA collection of raw permission names

effective_permissionsv1EffectivePermissionCollection (object)

source_node_typesv1NodeSpecCollection (object)

required_intermediate_node_typesv1NodeSpecCollection (object)

avoided_intermediate_node_typesv1NodeSpecCollection (object)

destination_node_typesv1NodeSpecCollection (object)

no_relationuse relates_to_exp

visibilityv1AssessmentVisibility (enum)

PUBLICPRIVATE

node_relationship_typeapi_protosv1NodeRelationshipType (enum)

EFFECTIVE_ACCESSCONFIGURED

labelsarray of string

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

all_entity_conditionNodeSpecCollectionConditionExpression (object)

path_summary_node_typesv1NodeSpecCollection (object)

path_summary_count_conditionsv1CountConditionCollection (object)

analysis_typev1AssessmentAnalysisType (enum)

UNSETUSERGROUPROLESEPARATION_OF_DUTYQUERY_PIPELINE

Response

200401403404500502503

A successful response.

Body

application/json

idstring

valuev1AssessmentQuery (object)

Request

JavaScriptCurl

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

Response

{
  "id": "text",
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "result_type": "NUMBER",
    "query_type": "SYSTEM_CREATED",
    "raw_permissions": {
      "values": [
        "text"
      ],
      "operator": "AND"
    },
    "effective_permissions": {
      "values": [
        "METADATA_WRITE"
      ],
      "operator": "AND"
    },
    "variables": [
      "text"
    ],
    "source_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ],
      "nodes_operator": "AND"
    },
    "required_intermediate_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ],
      "nodes_operator": "AND"
    },
    "avoided_intermediate_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ],
      "nodes_operator": "AND"
    },
    "destination_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ],
      "nodes_operator": "AND"
    },
    "no_relation": false,
    "created_by": "text",
    "visibility": "PUBLIC",
    "owners": [
      "text"
    ],
    "node_relationship_type": "EFFECTIVE_ACCESS",
    "integration_types": [
      "text"
    ],
    "labels": [
      "text"
    ],
    "created_at": "2024-04-30T14:28:35.834Z",
    "updated_at": "2024-04-30T14:28:35.834Z",
    "source_type": "text",
    "destination_types": [
      "text"
    ],
    "relates_to_exp": {
      "specs": [
        {
          "node_types": {
            "nodes": [
              {
                "node_type": "text",
                "tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "conditions": [
                  {
                    "fn": "EQ",
                    "property": "text",
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": false
                  }
                ],
                "condition_expression": {
                  "specs": [
                    {
                      "fn": "EQ",
                      "property": "text",
                      "not": false,
                      "value_property_name": "text",
                      "value_property_from_other_node": false
                    }
                  ],
                  "child_expressions": [],
                  "operator": "AND",
                  "not": false
                },
                "node_id": "text",
                "excluded_tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value": "text",
                    "value_as": "COUNT"
                  }
                ],
                "direct_relationship_only": false,
                "node_type_grouping_constraint": {
                  "node_types": [
                    "text"
                  ],
                  "constraint_type": "EXCLUDE"
                },
                "properties_to_get": [
                  "text"
                ]
              }
            ],
            "nodes_operator": "AND"
          },
          "required_intermediate_node_types": {
            "nodes": [
              {
                "node_type": "text",
                "tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "conditions": [
                  {
                    "fn": "EQ",
                    "property": "text",
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": false
                  }
                ],
                "condition_expression": {
                  "specs": [
                    {
                      "fn": "EQ",
                      "property": "text",
                      "not": false,
                      "value_property_name": "text",
                      "value_property_from_other_node": false
                    }
                  ],
                  "child_expressions": [],
                  "operator": "AND",
                  "not": false
                },
                "node_id": "text",
                "excluded_tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value": "text",
                    "value_as": "COUNT"
                  }
                ],
                "direct_relationship_only": false,
                "node_type_grouping_constraint": {
                  "node_types": [
                    "text"
                  ],
                  "constraint_type": "EXCLUDE"
                },
                "properties_to_get": [
                  "text"
                ]
              }
            ],
            "nodes_operator": "AND"
          },
          "avoided_intermediate_node_types": {
            "nodes": [
              {
                "node_type": "text",
                "tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "conditions": [
                  {
                    "fn": "EQ",
                    "property": "text",
                    "not": false,
                    "value_property_name": "text",
                    "value_property_from_other_node": false
                  }
                ],
                "condition_expression": {
                  "specs": [
                    {
                      "fn": "EQ",
                      "property": "text",
                      "not": false,
                      "value_property_name": "text",
                      "value_property_from_other_node": false
                    }
                  ],
                  "child_expressions": [],
                  "operator": "AND",
                  "not": false
                },
                "node_id": "text",
                "excluded_tags": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value": "text",
                    "value_as": "COUNT"
                  }
                ],
                "direct_relationship_only": false,
                "node_type_grouping_constraint": {
                  "node_types": [
                    "text"
                  ],
                  "constraint_type": "EXCLUDE"
                },
                "properties_to_get": [
                  "text"
                ]
              }
            ],
            "nodes_operator": "AND"
          },
          "raw_permissions": {
            "values": [
              "text"
            ],
            "operator": "AND"
          },
          "effective_permissions": {
            "values": [
              "METADATA_WRITE"
            ],
            "operator": "AND"
          },
          "no_relation": false,
          "direction": "ANY_DIRECTION"
        }
      ],
      "child_expressions": [],
      "operator": "AND",
      "not": false,
      "and_op_type": "INFERRED"
    },
    "all_entity_condition": {
      "specs": [
        {
          "fn": "EQ",
          "property": "text",
          "not": false,
          "value_property_name": "text",
          "value_property_from_other_node": false
        }
      ],
      "child_expressions": [],
      "operator": "AND",
      "not": false
    },
    "path_summary_node_types": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ],
      "nodes_operator": "AND"
    },
    "path_summary_count_conditions": {
      "conditions": [
        {
          "fn": "EQ",
          "value": "text",
          "value_as": "COUNT"
        }
      ]
    },
    "risk_level": "NONE",
    "risk_suppressed_constraints": {
      "nodes": [
        {
          "node_type": "text",
          "tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "conditions": [
            {
              "fn": "EQ",
              "property": "text",
              "not": false,
              "value_property_name": "text",
              "value_property_from_other_node": false
            }
          ],
          "condition_expression": {
            "specs": [
              {
                "fn": "EQ",
                "property": "text",
                "not": false,
                "value_property_name": "text",
                "value_property_from_other_node": false
              }
            ],
            "child_expressions": [],
            "operator": "AND",
            "not": false
          },
          "node_id": "text",
          "excluded_tags": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value": "text",
              "value_as": "COUNT"
            }
          ],
          "direct_relationship_only": false,
          "node_type_grouping_constraint": {
            "node_types": [
              "text"
            ],
            "constraint_type": "EXCLUDE"
          },
          "properties_to_get": [
            "text"
          ]
        }
      ]
    },
    "analysis_type": "UNSET",
    "result_evaluated_at": "2024-04-30T14:28:35.834Z",
    "result_evaluated": false
  }
}

Sample request:

See create query and query parameters for more details on the saved query object.

curl -X 'GET' \
"$BASE_URL/api/v1/assessments/queries/06799e24-cd93-4509-94bc-f00b27ed5e3c" \
-H "authorization: Bearer $VEZA_TOKEN" \
-d '{"source_node_types":{"nodes":[{"node_type":"OktaUser","tags":[],"excluded_tags":[],"count_conditions":[],"direct_relationship_only":false,"node_type_grouping_constraint":null}]},"destination_node_types":{"nodes":[{"node_type":"S3Bucket","tags":[],"excluded_tags":[],"count_conditions":[],"direct_relationship_only":false,"node_type_grouping_constraint":null}]},"node_relationship_type":"EFFECTIVE_ACCESS","no_relation":false,"query_type":"SOURCE_TO_DESTINATION","raw_permissions":null,"effective_permissions":null,"include_nodes":true,"customized_variables":[],"name":"Okta User to S3","description":"updated description","labels":[],"visibility":"PRIVATE"}'

• {id} (path) - string - ID of the query to modify.

Sample response:

A successful response will include the query details within a value object:

{"value":{"id":"06799e24-cd93-4509-94bc-f00b27ed5e3c","name":"Okta User to S3 - time machine","description":"specifies a snapshot to query against","result_type":"NUMBER","query_type":"SOURCE_TO_DESTINATION","raw_permissions":{"values":[],"operator":"AND"},"effective_permissions":{"values":[],"operator":"AND"},"variables":[],"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"},"required_intermediate_node_types":{"nodes":[],"nodes_operator":"AND"},"avoided_intermediate_node_types":{"nodes":[],"nodes_operator":"AND"},"destination_node_types":{"nodes":[],"nodes_operator":"AND"},"no_relation":false,"access_filter":null,"created_by":"e3ac5e6a-1946-4688-82a7-8a607133a1c8","visibility":"PRIVATE","owners":["e3ac5e6a-1946-4688-82a7-8a607133a1c8"],"node_relationship_type":"EFFECTIVE_ACCESS","integration_types":["aws","okta"],"labels":[],"created_at":"2023-07-29T20:18:12.781964505Z","updated_at":"2023-07-29T20:18:57.359434701Z","source_type":"OktaUser","destination_types":["S3Bucket"],"relates_to_exp":{"specs":[{"node_types":{"nodes":[{"node_type":"S3Bucket","tags":[],"conditions":[],"condition_expression":null,"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":null,"no_relation":false,"direction":"ANY_DIRECTION"}],"child_expressions":[],"operator":"AND","not":false,"and_op_type":"INFERRED"},"all_entity_condition":{"specs":[],"child_expressions":[],"operator":"AND","not":false},"risk_level":"NONE","risk_suppressed_constraints":null,"analysis_type":"UNSET","result":0,"result_evaluated_at":null,"result_evaluated":false}}