Software Secure Workload
Activity Configure

Secure Workload OpenAPIs Scopes Scope object

Last updated: Jun 09, 2025

Scope object

The scope object attributes are described below:

Attribute

Type

Description

id

string

Unique identifier for the scope.

short_name

string

User specified name of the scope.

name

string

Fully qualified name of the scope. This is a fully qualified name, i.e. it has name of parent scopes (if applicable) all the way to the root scope.

description

string

User specified description of the scope.

short_query

JSON

Filter (or match criteria) associated with the scope.

query

JSON

Filter (or match criteria) associated with the scope in conjunction with the filters of the parent scopes (all the way to the root scope).

vrf_id

integer

ID of the VRF to which scope belongs to.

parent_app_scope_id

string

ID of the parent scope.

child_app_scope_ids

array

An array of scope children’s ids.

policy_priority

Used to sort workspace priorities. See Semantics and Viewing.

dirty

bool

Indicates a child or parent query has been updated and that the changes need to be committed.

dirty_short_query

JSON

Non-null if the query for this scope has been updated but not yet committed.