Get specific workflow version
Retrieve a specific version of a workflow
Path Parameters
- workflow_id string required
Workflow identifier
- version integer required
Possible values:
>= 1Workflow version number
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
- 200
- 404
Workflow version details
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64cursor_pagination object
limit integercursor stringtotal_count int64errors object[]
httpcode integermessage stringresult object
id stringUnique configuration identifier
workflow_id stringParent workflow ID
org_id stringOrganization ID
version integerPossible values:
>= 1Configuration version number
data_input_config object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
type stringPossible values: [
detection]Data input type discriminator
scim_filter stringPossible values:
non-emptySCIM filter string to apply when querying detections. Examples:
severity eq "critical"type eq "aws_identity_unused" and status eq "new"entity_type eq "aws_iam_user"severity eq "critical" or severity eq "high"
limit integerPossible values:
<= 10000Maximum number of detections to retrieve (0 for no limit)
sorting object[]
Sorting configuration for results
field stringField to sort by
direction stringPossible values: [
asc,desc]Default value:
descSort direction
type stringPossible values: [
lifecycle]Data input type discriminator
event_types string[]Possible values: [
created,deleted,suspended,modified,reactivated,role_changed,group_added,group_removed,risk_score_changed,inactive_threshold],>= 1Lifecycle events that trigger this workflow
entity_types string[]Filter by entity types (e.g., aws_iam_user, entra_user). If empty, all entity types are matched.
source_types string[]Filter by identity source types (e.g., aws_account, entra). If empty, all source types are matched.
connection_ids string[]Filter by specific connection IDs. If empty, all connections are matched.
min_risk_score integerPossible values:
<= 100Only trigger for entities with risk score >= this value
max_risk_score integerPossible values:
<= 100Only trigger for entities with risk score <= this value
include_relationships booleanDefault value:
falseFetch manager, groups, direct reports from Neo4j
include_permissions booleanDefault value:
falseFetch permission assignments from Neo4j
include_access_history booleanDefault value:
falseFetch recent access records from Neo4j
relationship_depth integerPossible values:
<= 3Default value:
1How deep to traverse relationships in Neo4j (default 1, max 3)
scim_filter stringAdditional SCIM-style filter criteria for the entity
type stringPossible values: [
uar_finding]Data input type discriminator
triggers string[]UarFindingV1 trigger reasons that fire this workflow (ANY match). Defaults to
["manual"]when empty.campaign_ids uuid[]Filter by specific campaign IDs. Empty matches all.
campaign_template_ids uuid[]Filter by campaign template IDs. Empty matches all.
campaign_types string[]Filter by campaign type (e.g.
user,resource,non_human_identity). Empty matches all.classification_tags string[]Filter by classification tags on the finding. Empty matches all.
outcomes string[]Filter by reviewer decision outcome (e.g.
approve,revoke). Empty matches all.only_effective booleanDefault value:
falseMatch only when
effective_outcome == outcome— the decision survived multi-tier escalation rather than being overridden.min_level integerFilter by decision level >= this value.
only_high_privilege booleanDefault value:
falseRestrict to findings flagged as high-privilege.
user_source_types string[]Filter by user identity source type. Empty matches all.
user_entity_types string[]Filter by user entity type. Empty matches all.
asset_source_types string[]Filter by asset source type. Empty matches all.
asset_entity_types string[]Filter by asset entity type. Empty matches all.
granting_entity_types string[]Filter by granting entity type (e.g. role, group). Empty matches all.
scim_filter stringOptional SCIM-style filter over the flattened finding payload, applied after the structured filters above.
type stringPossible values: [
cypher_query]Data input type discriminator
query stringPossible values:
non-emptyand<= 10000 charactersRead-only Cypher query whose rows feed downstream workflow actions. Must contain MATCH and RETURN clauses. Write operations and the USE clause are rejected by the validator. Comments and strings are tokenized before validation, so a write keyword inside a string literal is allowed.
parameters object
Parameters bound into the query at execution time. Keys must match the
$nameplaceholders inquery. Values are passed verbatim to the Neo4j driver.max_rows integerPossible values:
>= 1and<= 10000Default value:
1000Maximum rows returned by a scheduled execution (NOT the preview). Capped server-side at 10000.
timeout_seconds integerPossible values:
>= 1and<= 300Default value:
30Per-execution query timeout (NOT the preview). Capped server-side at 300.
on_limit_exceeded stringPossible values: [
fail,truncate]Default value:
failBehavior when the query returns more than
max_rows.failaborts the execution with an error;truncatereturns the firstmax_rowsrows and marks the execution as truncated.primary_entity_column stringOptional. Name of a query result column whose value is the primary entity ID for each row. When set, downstream remediation actions can target this entity. Must match one of the column aliases in the query's RETURN clause.
actions object
Actions configuration. Map of action ID to action configuration.
discriminatorPossible values: [
remediation,ticket,data_sink,webhook,notification,condition]oneOfstarting_actions string[]IDs of actions to execute first (after data input).
schedule stringOptional cron expression (5-field, UTC). When non-empty, the workflow is registered with the scheduler and fires on each tick (cron parser: github.com/hashicorp/cronexpr). Must be empty when
data_input_config.typeislifecycle— lifecycle workflows are event-driven and cannot be scheduled.created_by stringUser ID who created this version
created_at date-timeVersion creation timestamp
is_latest booleanWhether this is the latest version
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
},
"cursor_pagination": {
"limit": 0,
"cursor": "string",
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
],
"result": {
"id": "string",
"workflow_id": "string",
"org_id": "string",
"version": 0,
"data_input_config": {
"type": "detection",
"scim_filter": "string",
"limit": 0,
"sorting": [
{
"field": "string",
"direction": "desc"
}
]
},
"actions": {},
"starting_actions": [
"string"
],
"schedule": "string",
"created_by": "string",
"created_at": "2005-12-24T18:29:30.033157Z",
"is_latest": true
}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
meta object
pagination object
limit integeroffset integertotal_count int64cursor_pagination object
limit integercursor stringtotal_count int64errors object[]
httpcode integermessage string
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
},
"cursor_pagination": {
"limit": 0,
"cursor": "string",
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}