list_effective_entities
Retrieve the effective set of entities for a threat model, including trust boundaries, components, assets, and attackers, each tagged with its provenance (own or inherited) and fully-qualified ID for unambiguous cross-model references.
Instructions
Effective entity set (own ⊕ inherited) keyed by kind.
Returns the entity set this model sees after composition with ancestors: trust boundaries, components, assets, attackers, and (when applicable) attack paths. Each entry carries its provenance — whether it originates on this model or is inherited from an ancestor — plus a fully-qualified id so cross-model references are unambiguous.
Pair with list_effective_control_objectives and
get_effective_coverage to see how inherited topology contributes
to coverage credit.
Return shape::
{
model_id, flag_enabled,
kinds: {
trust_boundaries: [{kind, qualified_id, owner_model_id,
owner_title, origin, entity}, ...],
components: [...], assets: [...], attackers: [...], ...
},
total, page, page_size,
}When composition is disabled on the backend, kinds is returned
with every kind mapped to an empty list and flag_enabled: false.
Omitting page / page_size defaults to page=1, page_size=100 — the response is paginated and no longer returns
every entity in a single call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | optional single entity kind to restrict the response to (e.g. ``"attackers"``, ``"assets"``, ``"components"``, ``"trust_boundaries"``). When omitted, all kinds are returned. | |
| page | No | 1-indexed page number (default ``1``). | |
| model_id | Yes | ID of the threat model. | |
| page_size | No | entries per page (default ``100``). | |
| server_version | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||