Public API reference

Welcome to the Public API reference documentation. This API provides programmatic access to your organization's security data, alerts, and configuration.

Public API Schema

Operations

Commonstorage Eventpublic

Click "Expand" to view 4 operations: graphQlStatus, savedSearches, savedCategories, eventsBySearchId.

Core

Click "Expand" to view 1 operation: organization.

JRS ACS

Click "Expand" to view 1 operation: hybridAgents.

JRS Audit

Click "Expand" to view 3 operations: forests, servers, brokers.

JRS Collections

Click "Expand" to view 1 operation: workloadsStatuses.

ODA Graphql

Click "Expand" to view 5 operations: odaConfigurationTenantConfigurations, identityDefenseFindingObjects, identityDefenseFindings, tierZeroPrivilegedObjects, odaTierZeroConfigurations.

ODG Assessmentgql

Click "Expand" to view 5 operations: assessmentOrganizationWorkloadList, organizationAssessmentListView, assessmentResultsSummaryView, assessmentResultsRuleSummaryView, vulnerabilityAffectedItems.

ODG Identitygql

Click "Expand" to view 7 operations: identityOrganizationWorkload, organizationIdentityTenants, servicePrincipalFlyouts, workloadIdentityFlyouts, organizationServicePrincipalList, organizationServiceAccountList, availableWorkloadIdentitiesList.

Interactive Playground

GraphQL Playground

Click "Execute Query" to see results

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: your-api-key

Getting an API Key

API keys can be generated for your organization within the Security Management Platform:

  1. Log in to the Security Management Platform
  2. Select Settings from the left navigation
  3. Navigate to API Keys > Public Key
  4. Click Create Key
  5. Enter a Name for the key
  6. Select an expiry from Expires in — options are 3, 6, 12, or 18 months
  7. Choose a Permissions level:
    • Full Access — grants access to all available API operations
    • Custom Access — selecting individual permissions allows to limit the scope of the token to only specific operations in Public API
  8. Click Save and copy your key — it will not be shown again

Rate Limits

Rate limiting is applied to all API requests.

Error Handling

The API uses standard GraphQL error responses:

{
  "errors": [
    {
      "message": "Organization not found",
      "locations": [{"line": 2, "column": 3}],
      "path": ["organization"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

Common error codes:

  • UNAUTHORIZED: Invalid or missing API key
  • FORBIDDEN: Insufficient permissions
  • NOT_FOUND: Resource doesn't exist
  • VALIDATION_ERROR: Invalid input parameters

Support