Skip to content
API Reference
/
/
organizationConfiguration

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

policyFilterOptions

PolicyFilterOptions!,non-null

Get filter options for policies including dynamic ranges for numeric and date fields. Returns min/max values for issuesCount, and lastExecutedAt.

Return type

PolicyFilterOptions!
issuesCountRange
IntRange!,non-null

Range of issues count across all policies

lastExecutedAtRange
DateTimeRange!,non-null

Range of last executed dates across all policies

Query sample
query policyFilterOptions {
  policyFilterOptions {
    issuesCountRange {
      __typename
      # ...IntRangeFragment
    }
    lastExecutedAtRange {
      __typename
      # ...DateTimeRangeFragment
    }
  }
}
Response sample
{
  "data": {
    "issuesCountRange": {
      "__typename": "IntRange"
    },
    "lastExecutedAtRange": {
      "__typename": "DateTimeRange"
    }
  }
}

previewPolicyImpact

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

Preview the impact of a policy before applying it. Shows matching entities and estimated issue impact (create/update/close counts).

Arguments

trigger
PolicyTriggerInput!,non-nullrequired
conditions
PolicyConditionGroupInput!,non-nullrequired
autoResolve
Boolean!,non-nullrequired
policyId
ID

Return type

PolicyImpactPreview!
matchingEntities
[MatchingEntityGroup!]!,non-null

Entities that match the policy conditions

Query sample
query previewPolicyImpact(
  $trigger: PolicyTriggerInput!
  $conditions: PolicyConditionGroupInput!
  $autoResolve: Boolean!
  $policyId: ID
) {
  previewPolicyImpact(
    trigger: $trigger
    conditions: $conditions
    autoResolve: $autoResolve
    policyId: $policyId
  ) {
    matchingEntities {
      __typename
      # ...MatchingEntityGroupFragment
    }
  }
}
Variables
{
  "trigger": {
    "type": "AGENT_CREATED"
  },
  "conditions": {
    "agentFilter": {
      "__typename": "AgentFilter"
    },
    "toolFilter": {
      "__typename": "ToolFilterInput"
    },
    "findingFilter": {
      "__typename": "FindingFilter"
    },
    "detectionFilter": {
      "__typename": "DetectionFilter"
    },
    "groups": [
      {
        "__typename": "PolicyConditionGroupInput"
      }
    ]
  },
  "autoResolve": true,
  "policyId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4"
}
Response sample
{
  "data": {
    "matchingEntities": [
      {
        "__typename": "MatchingEntityGroup"
      }
    ]
  }
}

generatePolicyMetadata

(...args)
PolicyMetadata

Generate AI-powered policy metadata (title and description) based on policy configuration. Typically takes 1-3 seconds. Should be debounced in the UI to avoid excessive calls. Optional field parameter allows generating only name or description for better caching.

Arguments

trigger
PolicyTriggerInput!,non-nullrequired
conditions
PolicyConditionGroupInput!,non-nullrequired
autoResolve
Boolean!,non-nullrequired
field
PolicyMetadataField

Return type

PolicyMetadata
title
String!,non-null

AI-generated title for the policy (5-8 words)

description
String!,non-null

AI-generated description explaining what this policy does (1-3 sentences)

Query sample
query generatePolicyMetadata(
  $trigger: PolicyTriggerInput!
  $conditions: PolicyConditionGroupInput!
  $autoResolve: Boolean!
  $field: PolicyMetadataField
) {
  generatePolicyMetadata(
    trigger: $trigger
    conditions: $conditions
    autoResolve: $autoResolve
    field: $field
  ) {
    title 
    description 
  }
}
Variables
{
  "trigger": {
    "type": "AGENT_CREATED"
  },
  "conditions": {
    "agentFilter": {
      "__typename": "AgentFilter"
    },
    "toolFilter": {
      "__typename": "ToolFilterInput"
    },
    "findingFilter": {
      "__typename": "FindingFilter"
    },
    "detectionFilter": {
      "__typename": "DetectionFilter"
    },
    "groups": [
      {
        "__typename": "PolicyConditionGroupInput"
      }
    ]
  },
  "autoResolve": true,
  "field": "NAME"
}
Response sample
{
  "data": {
    "title": "Example String",
    "description": "Example String"
  }
}

users

[User!]!,non-null

Get a list of users with optional filtering and sorting

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
Query sample
query users {
  users {
    id 
    firstName 
    lastName 
    email 
    role 
    createdAt 
    updatedAt 
    status 
  }
}
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"
    }
  ]
}

exportUsers

(type)
String!,non-null

Export users with same filtering and sorting as users query

Arguments

type
ExportType!,non-nullrequired

Return type

String!

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Query sample
query exportUsers($type: ExportType!) {
  exportUsers(type: $type) 
}
Variables
{
  "type": "CSV"
}
Response sample
{
  "data": "Example String"
}

organizationConfiguration

OrganizationConfiguration!,non-null

Get SSO configuration for an organization

Return type

OrganizationConfiguration!
id
ID!,non-null
name
String!,non-null
ssoConfig
OrganizationSSOConfiguration!,non-null
Query sample
query organizationConfiguration {
  organizationConfiguration {
    id 
    name 
    ssoConfig {
      __typename
      # ...OrganizationSSOConfigurationFragment
    }
  }
}
Response sample
{
  "data": {
    "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4",
    "name": "Example String",
    "ssoConfig": {
      "__typename": "OrganizationSSOConfiguration"
    }
  }
}

Mutations

Overview

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview