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}

Authorizations

Path parameters

idstringrequired

Body

namestring

descriptionstring

raw_permissionsA collection of raw permission names

effective_permissionsobject

source_node_typesobject

required_intermediate_node_typesobject

avoided_intermediate_node_typesobject

destination_node_typesobject

no_relationuse relates_to_exp

visibilitystring · enum · default: PUBLIC

Options: PUBLIC, PRIVATE

node_relationship_typestring · enum · default: EFFECTIVE_ACCESS

Options: EFFECTIVE_ACCESS, CONFIGURED

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_conditionobject

path_summary_node_typesobject

path_summary_count_conditionsobject

analysis_typestring · enum · default: UNSET

Options: UNSET, USER, GROUP, ROLE, SEPARATION_OF_DUTY, QUERY_PIPELINE

labelsstring[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/assessments/queries/{id}' \
  --header 'Bearer: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"raw_permissions":{"operator":"AND","values":[null]},"effective_permissions":{"operator":"AND","values":["METADATA_WRITE"]},"source_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"required_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"avoided_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"destination_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"visibility":"PUBLIC","node_relationship_type":"EFFECTIVE_ACCESS","relates_to_exp":{"operator":"AND","and_op_type":"INFERRED","specs":[{"node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"required_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"avoided_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"raw_permissions":{"operator":"AND","values":[null]},"effective_permissions":{"operator":"AND","values":["METADATA_WRITE"]},"direction":"ANY_DIRECTION"}],"child_expressions":[{"operator":"AND","and_op_type":"INFERRED","specs":[{"node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"required_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"avoided_intermediate_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"raw_permissions":{"operator":"AND","values":[null]},"effective_permissions":{"operator":"AND","values":["METADATA_WRITE"]},"direction":"ANY_DIRECTION"}],"child_expressions":[{"operator":"AND","and_op_type":"INFERRED","specs":"[Circular Reference]","child_expressions":"[Circular Reference]"}]}]},"all_entity_condition":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":[{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":[{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":"[Circular Reference]"}]}]},"path_summary_node_types":{"nodes_operator":"AND","nodes":[{"condition_expression":{"operator":"AND","specs":[{"fn":"EQ"}],"child_expressions":["[Circular Reference]"]},"node_type_grouping_constraint":{"constraint_type":"EXCLUDE","node_types":[null]},"tags":[{}],"conditions":[{"fn":"EQ"}],"excluded_tags":[{}],"count_conditions":[{"fn":"EQ","value_as":"COUNT"}],"properties_to_get":[null]}]},"path_summary_count_conditions":{"conditions":[{"fn":"EQ","value_as":"COUNT"}]},"analysis_type":"UNSET","labels":[null]}'

200

401

403

404

500

502

503

200

{
  "id": "text",
  "value": {
    "id": "text",
    "name": "text",
    "description": "text",
    "result_type": "NUMBER",
    "query_type": "SYSTEM_CREATED",
    "raw_permissions": {
      "operator": "AND",
      "values": [
        "text"
      ]
    },
    "effective_permissions": {
      "operator": "AND",
      "values": [
        "METADATA_WRITE"
      ]
    },
    "source_node_types": {
      "nodes_operator": "AND",
      "nodes": [
        {
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            null
          ]
        }
      ]
    },
    "required_intermediate_node_types": {
      "nodes_operator": "AND",
      "nodes": [
        {
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            null
          ]
        }
      ]
    },
    "avoided_intermediate_node_types": {
      "nodes_operator": "AND",
      "nodes": [
        {
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            null
          ]
        }
      ]
    },
    "destination_node_types": {
      "nodes_operator": "AND",
      "nodes": [
        {
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            null
          ]
        }
      ]
    },
    "no_relation": true,
    "created_by": "text",
    "visibility": "PUBLIC",
    "node_relationship_type": "EFFECTIVE_ACCESS",
    "created_at": "2025-02-20T19:19:31.627Z",
    "updated_at": "2025-02-20T19:19:31.627Z",
    "source_type": "text",
    "relates_to_exp": {
      "operator": "AND",
      "not": true,
      "and_op_type": "INFERRED",
      "specs": [
        {
          "node_types": {
            "nodes_operator": "AND",
            "nodes": [
              {
                "condition_expression": {
                  "operator": "AND",
                  "specs": [
                    {
                      "fn": "EQ"
                    }
                  ],
                  "child_expressions": [
                    "[Circular Reference]"
                  ]
                },
                "node_type_grouping_constraint": {
                  "constraint_type": "EXCLUDE",
                  "node_types": [
                    null
                  ]
                },
                "tags": [
                  {}
                ],
                "conditions": [
                  {
                    "fn": "EQ"
                  }
                ],
                "excluded_tags": [
                  {}
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value_as": "COUNT"
                  }
                ],
                "properties_to_get": [
                  null
                ]
              }
            ]
          },
          "required_intermediate_node_types": {
            "nodes_operator": "AND",
            "nodes": [
              {
                "condition_expression": {
                  "operator": "AND",
                  "specs": [
                    {
                      "fn": "EQ"
                    }
                  ],
                  "child_expressions": [
                    "[Circular Reference]"
                  ]
                },
                "node_type_grouping_constraint": {
                  "constraint_type": "EXCLUDE",
                  "node_types": [
                    null
                  ]
                },
                "tags": [
                  {}
                ],
                "conditions": [
                  {
                    "fn": "EQ"
                  }
                ],
                "excluded_tags": [
                  {}
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value_as": "COUNT"
                  }
                ],
                "properties_to_get": [
                  null
                ]
              }
            ]
          },
          "avoided_intermediate_node_types": {
            "nodes_operator": "AND",
            "nodes": [
              {
                "condition_expression": {
                  "operator": "AND",
                  "specs": [
                    {
                      "fn": "EQ"
                    }
                  ],
                  "child_expressions": [
                    "[Circular Reference]"
                  ]
                },
                "node_type_grouping_constraint": {
                  "constraint_type": "EXCLUDE",
                  "node_types": [
                    null
                  ]
                },
                "tags": [
                  {}
                ],
                "conditions": [
                  {
                    "fn": "EQ"
                  }
                ],
                "excluded_tags": [
                  {}
                ],
                "count_conditions": [
                  {
                    "fn": "EQ",
                    "value_as": "COUNT"
                  }
                ],
                "properties_to_get": [
                  null
                ]
              }
            ]
          },
          "raw_permissions": {
            "operator": "AND",
            "values": [
              null
            ]
          },
          "effective_permissions": {
            "operator": "AND",
            "values": [
              "METADATA_WRITE"
            ]
          },
          "direction": "ANY_DIRECTION"
        }
      ],
      "child_expressions": [
        {
          "operator": "AND",
          "and_op_type": "INFERRED",
          "specs": [
            {
              "node_types": {
                "nodes_operator": "AND",
                "nodes": [
                  {
                    "condition_expression": {
                      "operator": "AND",
                      "specs": [
                        {
                          "fn": "EQ"
                        }
                      ],
                      "child_expressions": [
                        "[Circular Reference]"
                      ]
                    },
                    "node_type_grouping_constraint": {
                      "constraint_type": "EXCLUDE",
                      "node_types": [
                        null
                      ]
                    },
                    "tags": [
                      {}
                    ],
                    "conditions": [
                      {
                        "fn": "EQ"
                      }
                    ],
                    "excluded_tags": [
                      {}
                    ],
                    "count_conditions": [
                      {
                        "fn": "EQ",
                        "value_as": "COUNT"
                      }
                    ],
                    "properties_to_get": [
                      null
                    ]
                  }
                ]
              },
              "required_intermediate_node_types": {
                "nodes_operator": "AND",
                "nodes": [
                  {
                    "condition_expression": {
                      "operator": "AND",
                      "specs": [
                        {
                          "fn": "EQ"
                        }
                      ],
                      "child_expressions": [
                        "[Circular Reference]"
                      ]
                    },
                    "node_type_grouping_constraint": {
                      "constraint_type": "EXCLUDE",
                      "node_types": [
                        null
                      ]
                    },
                    "tags": [
                      {}
                    ],
                    "conditions": [
                      {
                        "fn": "EQ"
                      }
                    ],
                    "excluded_tags": [
                      {}
                    ],
                    "count_conditions": [
                      {
                        "fn": "EQ",
                        "value_as": "COUNT"
                      }
                    ],
                    "properties_to_get": [
                      null
                    ]
                  }
                ]
              },
              "avoided_intermediate_node_types": {
                "nodes_operator": "AND",
                "nodes": [
                  {
                    "condition_expression": {
                      "operator": "AND",
                      "specs": [
                        {
                          "fn": "EQ"
                        }
                      ],
                      "child_expressions": [
                        "[Circular Reference]"
                      ]
                    },
                    "node_type_grouping_constraint": {
                      "constraint_type": "EXCLUDE",
                      "node_types": [
                        null
                      ]
                    },
                    "tags": [
                      {}
                    ],
                    "conditions": [
                      {
                        "fn": "EQ"
                      }
                    ],
                    "excluded_tags": [
                      {}
                    ],
                    "count_conditions": [
                      {
                        "fn": "EQ",
                        "value_as": "COUNT"
                      }
                    ],
                    "properties_to_get": [
                      null
                    ]
                  }
                ]
              },
              "raw_permissions": {
                "operator": "AND",
                "values": [
                  null
                ]
              },
              "effective_permissions": {
                "operator": "AND",
                "values": [
                  "METADATA_WRITE"
                ]
              },
              "direction": "ANY_DIRECTION"
            }
          ],
          "child_expressions": [
            {
              "operator": "AND",
              "and_op_type": "INFERRED",
              "specs": "[Circular Reference]",
              "child_expressions": "[Circular Reference]"
            }
          ]
        }
      ]
    },
    "all_entity_condition": {
      "operator": "AND",
      "not": true,
      "specs": [
        {
          "fn": "EQ"
        }
      ],
      "child_expressions": [
        {
          "operator": "AND",
          "specs": [
            {
              "fn": "EQ"
            }
          ],
          "child_expressions": [
            {
              "operator": "AND",
              "specs": [
                {
                  "fn": "EQ"
                }
              ],
              "child_expressions": "[Circular Reference]"
            }
          ]
        }
      ]
    },
    "path_summary_node_types": {
      "nodes_operator": "AND",
      "nodes": [
        {
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            null
          ]
        }
      ]
    },
    "path_summary_count_conditions": {
      "conditions": [
        {
          "fn": "EQ",
          "value_as": "COUNT"
        }
      ]
    },
    "risk_level": "NONE",
    "risk_suppressed_constraints": {
      "nodes": [
        {
          "node_type": "text",
          "condition_expression": {
            "operator": "AND",
            "specs": [
              {
                "fn": "EQ"
              }
            ],
            "child_expressions": [
              "[Circular Reference]"
            ]
          },
          "node_id": "text",
          "direct_relationship_only": true,
          "node_type_grouping_constraint": {
            "constraint_type": "EXCLUDE",
            "node_types": [
              null
            ]
          },
          "tags": [
            {}
          ],
          "conditions": [
            {
              "fn": "EQ"
            }
          ],
          "excluded_tags": [
            {}
          ],
          "count_conditions": [
            {
              "fn": "EQ",
              "value_as": "COUNT"
            }
          ],
          "properties_to_get": [
            "text"
          ]
        }
      ]
    },
    "analysis_type": "UNSET",
    "result": 1,
    "result_evaluated_at": "2025-02-20T19:19:31.627Z",
    "result_evaluated": true,
    "variables": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "integration_types": [
      "text"
    ],
    "labels": [
      "text"
    ],
    "destination_types": [
      "text"
    ]
  }
}

A successful response.

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}}