Skip to content
API Reference
/
/
createUser

GraphQL Overview

Download GraphQL schema
agent.graphql

Queries

Overview

Mutations

Overview

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

createUser

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

Arguments

email
String!,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 createUser(
  $email: String!
  $firstName: String!
  $lastName: String!
  $role: UserRole!
) {
  createUser(
    email: $email
    firstName: $firstName
    lastName: $lastName
    role: $role
  ) {
    id 
    firstName 
    lastName 
    email 
    role 
    createdAt 
    updatedAt 
    status 
  }
}
Variables
{
  "email": "Example String",
  "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"
  }
}

setOrganizationSSOConfiguration

(config)
OrganizationSSOConfiguration!,non-null

Configure SSO for an organization

Arguments

config
ConfigureSSOInput!,non-nullrequired

Return type

OrganizationSSOConfiguration!
enabled
Boolean!,non-null
values
OrganizationSSOConfigurationValues
Mutation sample
mutation setOrganizationSSOConfiguration($config: ConfigureSSOInput!) {
  setOrganizationSSOConfiguration(config: $config) {
    enabled 
    values {
      __typename
      # ...OrganizationSSOConfigurationValuesFragment
    }
  }
}
Variables
{
  "config": {
    "signInEndpoint": "Example String",
    "signingCertBase64": "Example String",
    "domains": [
      "Example String"
    ]
  }
}
Response sample
{
  "data": {
    "enabled": true,
    "values": {
      "__typename": "OrganizationSSOConfigurationValues"
    }
  }
}

clearOrganizationSSOConfiguration

OrganizationSSOConfiguration!,non-null

Clear SSO configuration for an organization

Return type

OrganizationSSOConfiguration!
enabled
Boolean!,non-null
values
OrganizationSSOConfigurationValues
Mutation sample
mutation clearOrganizationSSOConfiguration {
  clearOrganizationSSOConfiguration {
    enabled 
    values {
      __typename
      # ...OrganizationSSOConfigurationValuesFragment
    }
  }
}
Response sample
{
  "data": {
    "enabled": true,
    "values": {
      "__typename": "OrganizationSSOConfigurationValues"
    }
  }
}

Objects

Overview

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview