Skip to content
API Reference
/
/
updatePolicy

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

syncIntegration

(platformType)
Integration!,non-null

Arguments

platformType
PlatformType!,non-nullrequired

Return type

Integration!
platform
Platform!,non-null
status
IntegrationStatus!,non-null
description
String!,non-null
error
String
Mutation sample
mutation syncIntegration($platformType: PlatformType!) {
  syncIntegration(platformType: $platformType) {
    platform {
      __typename
      # ...PlatformFragment
    }
    status 
    description 
    error 
  }
}
Variables
{
  "platformType": "POWERPLATFORM"
}
Response sample
{
  "data": {
    "platform": {
      "__typename": "Platform"
    },
    "status": "DISABLED",
    "description": "Example String",
    "error": "Example String"
  }
}

syncAgent

(agentId)
Agent!,non-null

Arguments

agentId
ID!,non-nullrequired

Return type

Agent!
externalId
ID!,non-null
id
ID!,non-null
platform
Platform!,non-null
name
String!,non-null
environment
Environment!,non-null
owner
Owner!,non-null
accessibility
AgentAccessibility!,non-null
description
String
nodes
[Node!]!,non-null
edges
[Edge!]!,non-null
tools
[Tool!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
highestIssueSeverity
Issue
usage
Usage
findings
[Finding!]!,non-null
detections
[DetectionTypeAggregation!],non-null
isRuntimeProtected
Boolean
Mutation sample
mutation syncAgent($agentId: ID!) {
  syncAgent(agentId: $agentId) {
    externalId 
    id 
    platform {
      __typename
      # ...PlatformFragment
    }
    name 
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    accessibility 
    description 
    nodes {
      id 
      name 
    }
    edges {
      connectionA 
      connectionB 
      direction 
      type 
    }
    tools {
      __typename
      # ...ToolFragment
    }
    createdAt 
    updatedAt 
    highestIssueSeverity {
      __typename
      # ...IssueFragment
    }
    usage {
      __typename
      # ...UsageFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    detections {
      __typename
      # ...DetectionTypeAggregationFragment
    }
    isRuntimeProtected 
  }
}
Variables
{
  "agentId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "platform": {
      "__typename": "Platform"
    },
    "name": "Example String",
    "environment": {
      "__typename": "Environment"
    },
    "owner": {
      "__typename": "Owner"
    },
    "accessibility": "PUBLIC",
    "description": "Example String",
    "nodes": [
      {
        "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
        "name": "Example String"
      }
    ],
    "edges": [
      {
        "connectionA": "Example String",
        "connectionB": "Example String",
        "direction": "ATOB",
        "type": "NORMAL"
      }
    ],
    "tools": [
      {
        "__typename": "Tool"
      }
    ],
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "highestIssueSeverity": {
      "__typename": "Issue"
    },
    "usage": {
      "__typename": "Usage"
    },
    "findings": [
      {
        "__typename": "Finding"
      }
    ],
    "detections": [
      {
        "__typename": "DetectionTypeAggregation"
      }
    ],
    "isRuntimeProtected": true
  }
}

testIntegrationConnection

(input)
IntegrationTestResult!,non-null

Arguments

input
TestIntegrationConnectionInput!,non-nullrequired

Return type

IntegrationTestResult!
success
Boolean!,non-null
error
IntegrationTestError
Mutation sample
mutation testIntegrationConnection($input: TestIntegrationConnectionInput!) {
  testIntegrationConnection(input: $input) {
    success 
    error {
      __typename
      # ...IntegrationTestErrorFragment
    }
  }
}
Variables
{
  "input": {
    "platformType": "POWERPLATFORM",
    "roleArn": "Example String"
  }
}
Response sample
{
  "data": {
    "success": true,
    "error": {
      "__typename": "IntegrationTestError"
    }
  }
}

syncFlow

(flowId)
Flow!,non-null

Arguments

flowId
ID!,non-nullrequired

Return type

Flow!
id
ID!,non-null
externalId
ID!,non-null
name
String!,non-null
description
String
platform
Platform!,non-null
environment
Environment!,non-null
owner
Owner
status
FlowStatus!,non-null
mode
FlowMode!,non-null
version
String
graph
FlowGraph!,non-null
agents
[AgentPreview!]!,non-null
tools
[ToolPreview!]!,non-null
dataSources
[DataSourcePreview!]!,non-null
findings
[Finding!]!,non-null
issues
[Issue!]!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
capturedAt
DateTime!,non-null
platformCreatedAt
DateTime
platformUpdatedAt
DateTime
metadata
JSON
Mutation sample
mutation syncFlow($flowId: ID!) {
  syncFlow(flowId: $flowId) {
    id 
    externalId 
    name 
    description 
    platform {
      __typename
      # ...PlatformFragment
    }
    environment {
      __typename
      # ...EnvironmentFragment
    }
    owner {
      __typename
      # ...OwnerFragment
    }
    status 
    mode 
    version 
    graph {
      __typename
      # ...FlowGraphFragment
    }
    agents {
      __typename
      # ...AgentPreviewFragment
    }
    tools {
      __typename
      # ...ToolPreviewFragment
    }
    dataSources {
      __typename
      # ...DataSourcePreviewFragment
    }
    findings {
      __typename
      # ...FindingFragment
    }
    issues {
      __typename
      # ...IssueFragment
    }
    createdAt 
    updatedAt 
    capturedAt 
    platformCreatedAt 
    platformUpdatedAt 
    metadata 
  }
}
Variables
{
  "flowId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "externalId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "description": "Example String",
    "platform": {
      "__typename": "Platform"
    },
    "environment": {
      "__typename": "Environment"
    },
    "owner": {
      "__typename": "Owner"
    },
    "status": "ACTIVE",
    "mode": "SYNC",
    "version": "Example String",
    "graph": {
      "__typename": "FlowGraph"
    },
    "agents": [
      {
        "__typename": "AgentPreview"
      }
    ],
    "tools": [
      {
        "__typename": "ToolPreview"
      }
    ],
    "dataSources": [
      {
        "__typename": "DataSourcePreview"
      }
    ],
    "findings": [
      {
        "__typename": "Finding"
      }
    ],
    "issues": [
      {
        "__typename": "Issue"
      }
    ],
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "capturedAt": "Example Custom Scalar",
    "platformCreatedAt": "Example Custom Scalar",
    "platformUpdatedAt": "Example Custom Scalar",
    "metadata": "Example Custom Scalar"
  }
}

createPolicy

(input)
Policy!,non-null

Create a new policy

Arguments

input
CreatePolicyInput!,non-nullrequired

Return type

Policy!
id
ID!,non-null

Unique identifier for the policy

name
String!,non-null

Policy name

description
String

Detailed description of what the policy does

mode
PolicyMode!,non-null

Current enforcement mode of the policy

status
PolicyStatus!,non-null

Current status of the policy

trigger
PolicyTrigger!,non-null

Event that triggers policy evaluation

conditions
PolicyConditionGroup!,non-null

Conditions that must be met for the policy to match

actions
[PolicyAction!]!,non-null

Actions to execute when policy conditions match

autoResolve
Boolean!,non-null

Automatically resolve issues when conditions are no longer met

isDefault
Boolean!,non-null

Indicates if this policy is a system default or custom/modified by the tenant

issuesCount
Int!,non-null

Number of issues created by this policy

lastExecutedAt
DateTime

When the policy was last executed

createdAt
DateTime!,non-null

When the policy was created

updatedAt
DateTime!,non-null

When the policy was last updated

createdBy
Owner

User who created the policy

updatedBy
Owner

User who last updated the policy

version
Int!,non-null

Version number, incremented on each update

deletedAt
DateTime

When the policy was soft-deleted (null if active)

environmentTypes
[EnvironmentType!]!,non-null

Effective environment types where this policy applies. Returns specific environments if conditions include environment filters, or all environments (Prod, Sandbox, Dev) if no environment filter is specified.

Mutation sample
mutation createPolicy($input: CreatePolicyInput!) {
  createPolicy(input: $input) {
    id 
    name 
    description 
    mode 
    status 
    trigger {
      __typename
      # ...PolicyTriggerFragment
    }
    conditions {
      __typename
      # ...PolicyConditionGroupFragment
    }
    actions {
      __typename
      # ...PolicyActionFragment
    }
    autoResolve 
    isDefault 
    issuesCount 
    lastExecutedAt 
    createdAt 
    updatedAt 
    createdBy {
      __typename
      # ...OwnerFragment
    }
    updatedBy {
      __typename
      # ...OwnerFragment
    }
    version 
    deletedAt 
    environmentTypes 
  }
}
Variables
{
  "input": {
    "name": "Example String",
    "trigger": {
      "__typename": "PolicyTriggerInput"
    },
    "conditions": {
      "__typename": "PolicyConditionGroupInput"
    },
    "actions": [
      {
        "__typename": "PolicyActionInput"
      }
    ],
    "autoResolve": true
  }
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "description": "Example String",
    "mode": "DRAFT",
    "status": "ACTIVE",
    "trigger": {
      "__typename": "PolicyTrigger"
    },
    "conditions": {
      "__typename": "PolicyConditionGroup"
    },
    "actions": [
      {
        "__typename": "PolicyAction"
      }
    ],
    "autoResolve": true,
    "isDefault": true,
    "issuesCount": 40,
    "lastExecutedAt": "Example Custom Scalar",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "createdBy": {
      "__typename": "Owner"
    },
    "updatedBy": {
      "__typename": "Owner"
    },
    "version": 40,
    "deletedAt": "Example Custom Scalar",
    "environmentTypes": [
      "Prod"
    ]
  }
}

updatePolicy

(...args)
Policy!,non-null

Update an existing policy

Arguments

id
ID!,non-nullrequired
input
UpdatePolicyInput!,non-nullrequired

Return type

Policy!
id
ID!,non-null

Unique identifier for the policy

name
String!,non-null

Policy name

description
String

Detailed description of what the policy does

mode
PolicyMode!,non-null

Current enforcement mode of the policy

status
PolicyStatus!,non-null

Current status of the policy

trigger
PolicyTrigger!,non-null

Event that triggers policy evaluation

conditions
PolicyConditionGroup!,non-null

Conditions that must be met for the policy to match

actions
[PolicyAction!]!,non-null

Actions to execute when policy conditions match

autoResolve
Boolean!,non-null

Automatically resolve issues when conditions are no longer met

isDefault
Boolean!,non-null

Indicates if this policy is a system default or custom/modified by the tenant

issuesCount
Int!,non-null

Number of issues created by this policy

lastExecutedAt
DateTime

When the policy was last executed

createdAt
DateTime!,non-null

When the policy was created

updatedAt
DateTime!,non-null

When the policy was last updated

createdBy
Owner

User who created the policy

updatedBy
Owner

User who last updated the policy

version
Int!,non-null

Version number, incremented on each update

deletedAt
DateTime

When the policy was soft-deleted (null if active)

environmentTypes
[EnvironmentType!]!,non-null

Effective environment types where this policy applies. Returns specific environments if conditions include environment filters, or all environments (Prod, Sandbox, Dev) if no environment filter is specified.

Mutation sample
mutation updatePolicy($id: ID!, $input: UpdatePolicyInput!) {
  updatePolicy(id: $id, input: $input) {
    id 
    name 
    description 
    mode 
    status 
    trigger {
      __typename
      # ...PolicyTriggerFragment
    }
    conditions {
      __typename
      # ...PolicyConditionGroupFragment
    }
    actions {
      __typename
      # ...PolicyActionFragment
    }
    autoResolve 
    isDefault 
    issuesCount 
    lastExecutedAt 
    createdAt 
    updatedAt 
    createdBy {
      __typename
      # ...OwnerFragment
    }
    updatedBy {
      __typename
      # ...OwnerFragment
    }
    version 
    deletedAt 
    environmentTypes 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "input": {
    "name": "Example String",
    "description": "Example String",
    "trigger": {
      "__typename": "PolicyTriggerInput"
    },
    "conditions": {
      "__typename": "PolicyConditionGroupInput"
    },
    "actions": [
      {
        "__typename": "PolicyActionInput"
      }
    ],
    "autoResolve": true
  }
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "description": "Example String",
    "mode": "DRAFT",
    "status": "ACTIVE",
    "trigger": {
      "__typename": "PolicyTrigger"
    },
    "conditions": {
      "__typename": "PolicyConditionGroup"
    },
    "actions": [
      {
        "__typename": "PolicyAction"
      }
    ],
    "autoResolve": true,
    "isDefault": true,
    "issuesCount": 40,
    "lastExecutedAt": "Example Custom Scalar",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "createdBy": {
      "__typename": "Owner"
    },
    "updatedBy": {
      "__typename": "Owner"
    },
    "version": 40,
    "deletedAt": "Example Custom Scalar",
    "environmentTypes": [
      "Prod"
    ]
  }
}

updatePolicyMode

(...args)
Policy!,non-null

Update policy mode

Arguments

id
ID!,non-nullrequired
mode
PolicyMode!,non-nullrequired

Return type

Policy!
id
ID!,non-null

Unique identifier for the policy

name
String!,non-null

Policy name

description
String

Detailed description of what the policy does

mode
PolicyMode!,non-null

Current enforcement mode of the policy

status
PolicyStatus!,non-null

Current status of the policy

trigger
PolicyTrigger!,non-null

Event that triggers policy evaluation

conditions
PolicyConditionGroup!,non-null

Conditions that must be met for the policy to match

actions
[PolicyAction!]!,non-null

Actions to execute when policy conditions match

autoResolve
Boolean!,non-null

Automatically resolve issues when conditions are no longer met

isDefault
Boolean!,non-null

Indicates if this policy is a system default or custom/modified by the tenant

issuesCount
Int!,non-null

Number of issues created by this policy

lastExecutedAt
DateTime

When the policy was last executed

createdAt
DateTime!,non-null

When the policy was created

updatedAt
DateTime!,non-null

When the policy was last updated

createdBy
Owner

User who created the policy

updatedBy
Owner

User who last updated the policy

version
Int!,non-null

Version number, incremented on each update

deletedAt
DateTime

When the policy was soft-deleted (null if active)

environmentTypes
[EnvironmentType!]!,non-null

Effective environment types where this policy applies. Returns specific environments if conditions include environment filters, or all environments (Prod, Sandbox, Dev) if no environment filter is specified.

Mutation sample
mutation updatePolicyMode($id: ID!, $mode: PolicyMode!) {
  updatePolicyMode(id: $id, mode: $mode) {
    id 
    name 
    description 
    mode 
    status 
    trigger {
      __typename
      # ...PolicyTriggerFragment
    }
    conditions {
      __typename
      # ...PolicyConditionGroupFragment
    }
    actions {
      __typename
      # ...PolicyActionFragment
    }
    autoResolve 
    isDefault 
    issuesCount 
    lastExecutedAt 
    createdAt 
    updatedAt 
    createdBy {
      __typename
      # ...OwnerFragment
    }
    updatedBy {
      __typename
      # ...OwnerFragment
    }
    version 
    deletedAt 
    environmentTypes 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "mode": "DRAFT"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "description": "Example String",
    "mode": "DRAFT",
    "status": "ACTIVE",
    "trigger": {
      "__typename": "PolicyTrigger"
    },
    "conditions": {
      "__typename": "PolicyConditionGroup"
    },
    "actions": [
      {
        "__typename": "PolicyAction"
      }
    ],
    "autoResolve": true,
    "isDefault": true,
    "issuesCount": 40,
    "lastExecutedAt": "Example Custom Scalar",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "createdBy": {
      "__typename": "Owner"
    },
    "updatedBy": {
      "__typename": "Owner"
    },
    "version": 40,
    "deletedAt": "Example Custom Scalar",
    "environmentTypes": [
      "Prod"
    ]
  }
}

updatePolicyStatus

(...args)
Policy!,non-null

Update policy status

Arguments

id
ID!,non-nullrequired
status
PolicyStatus!,non-nullrequired

Return type

Policy!
id
ID!,non-null

Unique identifier for the policy

name
String!,non-null

Policy name

description
String

Detailed description of what the policy does

mode
PolicyMode!,non-null

Current enforcement mode of the policy

status
PolicyStatus!,non-null

Current status of the policy

trigger
PolicyTrigger!,non-null

Event that triggers policy evaluation

conditions
PolicyConditionGroup!,non-null

Conditions that must be met for the policy to match

actions
[PolicyAction!]!,non-null

Actions to execute when policy conditions match

autoResolve
Boolean!,non-null

Automatically resolve issues when conditions are no longer met

isDefault
Boolean!,non-null

Indicates if this policy is a system default or custom/modified by the tenant

issuesCount
Int!,non-null

Number of issues created by this policy

lastExecutedAt
DateTime

When the policy was last executed

createdAt
DateTime!,non-null

When the policy was created

updatedAt
DateTime!,non-null

When the policy was last updated

createdBy
Owner

User who created the policy

updatedBy
Owner

User who last updated the policy

version
Int!,non-null

Version number, incremented on each update

deletedAt
DateTime

When the policy was soft-deleted (null if active)

environmentTypes
[EnvironmentType!]!,non-null

Effective environment types where this policy applies. Returns specific environments if conditions include environment filters, or all environments (Prod, Sandbox, Dev) if no environment filter is specified.

Mutation sample
mutation updatePolicyStatus($id: ID!, $status: PolicyStatus!) {
  updatePolicyStatus(id: $id, status: $status) {
    id 
    name 
    description 
    mode 
    status 
    trigger {
      __typename
      # ...PolicyTriggerFragment
    }
    conditions {
      __typename
      # ...PolicyConditionGroupFragment
    }
    actions {
      __typename
      # ...PolicyActionFragment
    }
    autoResolve 
    isDefault 
    issuesCount 
    lastExecutedAt 
    createdAt 
    updatedAt 
    createdBy {
      __typename
      # ...OwnerFragment
    }
    updatedBy {
      __typename
      # ...OwnerFragment
    }
    version 
    deletedAt 
    environmentTypes 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "status": "ACTIVE"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "description": "Example String",
    "mode": "DRAFT",
    "status": "ACTIVE",
    "trigger": {
      "__typename": "PolicyTrigger"
    },
    "conditions": {
      "__typename": "PolicyConditionGroup"
    },
    "actions": [
      {
        "__typename": "PolicyAction"
      }
    ],
    "autoResolve": true,
    "isDefault": true,
    "issuesCount": 40,
    "lastExecutedAt": "Example Custom Scalar",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "createdBy": {
      "__typename": "Owner"
    },
    "updatedBy": {
      "__typename": "Owner"
    },
    "version": 40,
    "deletedAt": "Example Custom Scalar",
    "environmentTypes": [
      "Prod"
    ]
  }
}

deletePolicy

(id)
Boolean!,non-null

Delete a policy

Arguments

id
ID!,non-nullrequired

Return type

Boolean!

The Boolean scalar type represents true or false.

Mutation sample
mutation deletePolicy($id: ID!) {
  deletePolicy(id: $id) 
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": true
}

updateUser

(...args)
User!,non-null

Arguments

id
ID!,non-nullrequired
firstName
String!,non-nullrequired
lastName
String!,non-nullrequired
role
UserRole!,non-nullrequired

Return type

User!
id
ID!,non-null
firstName
String
lastName
String
email
String!,non-null
role
UserRole!,non-null
createdAt
DateTime!,non-null
updatedAt
DateTime!,non-null
status
UserStatus!,non-null
Mutation sample
mutation updateUser(
  $id: ID!
  $firstName: String!
  $lastName: String!
  $role: UserRole!
) {
  updateUser(
    id: $id
    firstName: $firstName
    lastName: $lastName
    role: $role
  ) {
    id 
    firstName 
    lastName 
    email 
    role 
    createdAt 
    updatedAt 
    status 
  }
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
  "firstName": "Example String",
  "lastName": "Example String",
  "role": "ADMIN"
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "firstName": "Example String",
    "lastName": "Example String",
    "email": "Example String",
    "role": "ADMIN",
    "createdAt": "Example Custom Scalar",
    "updatedAt": "Example Custom Scalar",
    "status": "ENABLED"
  }
}

removeUserFromTenant

(id)
ID!,non-null

Arguments

id
ID!,non-nullrequired

Return type

ID!

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Mutation sample
mutation removeUserFromTenant($id: ID!) {
  removeUserFromTenant(id: $id) 
}
Variables
{
  "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview