Skip to content
API Reference
/
/
finishIntegrationInstalla...

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

startIntegrationInstallation

(platformType)
IntegrationInstallationResponse!,non-null

Arguments

platformType
PlatformType!,non-nullrequired

Return type

IntegrationInstallationResponse!
integration
Integration!,non-null
error
String
redirectUri
String
claudeCodeConfig
ClaudeCodeConfig
gitHubCopilotConfig
GitHubCopilotConfig
Mutation sample
mutation startIntegrationInstallation($platformType: PlatformType!) {
  startIntegrationInstallation(platformType: $platformType) {
    integration {
      __typename
      # ...IntegrationFragment
    }
    error 
    redirectUri 
    claudeCodeConfig {
      __typename
      # ...ClaudeCodeConfigFragment
    }
    gitHubCopilotConfig {
      __typename
      # ...GitHubCopilotConfigFragment
    }
  }
}
Variables
{
  "platformType": "POWERPLATFORM"
}
Response sample
{
  "data": {
    "integration": {
      "__typename": "Integration"
    },
    "error": "Example String",
    "redirectUri": "Example String",
    "claudeCodeConfig": {
      "__typename": "ClaudeCodeConfig"
    },
    "gitHubCopilotConfig": {
      "__typename": "GitHubCopilotConfig"
    }
  }
}

finishIntegrationInstallation

(installIntegrationInput)
Integration!,non-null

Arguments

installIntegrationInput
InstallIntegrationInput!,non-nullrequired

Return type

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

updateIntegrationStatus

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

Arguments

platformType
PlatformType!,non-nullrequired
enabled
Boolean!,non-nullrequired

Return type

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

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

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview