Skip to content

GraphQL Overview

Download GraphQL schema

Queries

Overview

Mutations

Overview

Objects

Overview

EnvironmentDistribution

Distribution of items by specific environment name

environment
String!,non-null

Specific environment name

count
Int!,non-null

Number of items in this environment

percentage
Float!,non-null

Percentage of items in this environment

Sample
{ "environment": "Example String", "count": 40, "percentage": 40 }

PolicyAggregations

Aggregated statistics for policies

total
Int!,non-null

Total number of policies matching the filter

productionCoverage
Float!,non-null

Percentage of production environments covered by policies (includes Unspecified)

byStatus

Distribution of policies by status (Active/Disabled)

byEnvironmentType

Distribution of policies across environment types

byEnvironment

Distribution of policies across specific environment names

Sample
{ "total": 40, "productionCoverage": 40, "byStatus": [ { "__typename": "StatusDistribution" } ], "byEnvironmentType": [ { "__typename": "EnvironmentTypeDistribution" } ], "byEnvironment": [ { "__typename": "EnvironmentDistribution" } ] }

User

Represents a user in the system

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

OrganizationConfiguration

Organization configuration

id
ID!,non-null
name
String!,non-null
Sample
{ "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "name": "Example String", "ssoConfig": { "__typename": "OrganizationSSOConfiguration" } }

OrganizationSSOConfiguration

enabled
Boolean!,non-null
Sample
{ "enabled": true, "values": { "__typename": "OrganizationSSOConfigurationValues" } }

OrganizationSSOConfigurationValues

Organization SSO configuration

strategy
SSOStrategy!,non-null
signInEndpoint
String!,non-null
domains
[String!]!,non-null
identifier
String!,non-null
replyUrl
String!,non-null
Sample
{ "strategy": "SAMLP", "signInEndpoint": "Example String", "domains": [ "Example String" ], "identifier": "Example String", "replyUrl": "Example String" }

Interfaces

Overview

Unions

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview