ActionNotificationsReadPayload
Return response for markNotificationsAsRead mutation
Fields
| Name | Description |
|---|
readIDs
[ID]! | Updated notification IDs |
ActionPlan
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
revision
String | revision of the object as a semver (e.g. v1.0.0), by default any update will bump the patch version, unless the revision_bump field is set |
name
String! | the name of the action_plan |
status
ActionPlanDocumentStatus | status of the action_plan, e.g. draft, published, archived, etc. |
details
String | details of the action_plan |
detailsJSON
[Any!] | structured details of the action_plan in JSON format |
approvalRequired
Boolean | whether approval is required for edits to the action_plan |
reviewDue
Time | the date the action_plan should be reviewed, calculated based on the review_frequency if not directly set |
reviewFrequency
ActionPlanFrequency | the frequency at which the action_plan should be reviewed, used to calculate the review_due date |
approverID
ID | the id of the group responsible for approving the action_plan |
delegateID
ID | the id of the group responsible for approving the action_plan |
summary
String | |
tagSuggestions
[String!] | auto-generated tag suggestions for the action_plan |
dismissedTagSuggestions
[String!] | tag suggestions dismissed by the user for the action_plan |
controlSuggestions
[String!] | proposed controls referenced in the action_plan |
dismissedControlSuggestions
[String!] | control suggestions dismissed by the user for the action_plan |
improvementSuggestions
[String!] | suggested improvements for the action_plan |
dismissedImprovementSuggestions
[String!] | improvement suggestions dismissed by the user for the action_plan |
url
String | This will contain the url used to create or update the action_plan |
fileID
ID | This will contain the most recent file id if this action_plan was created from a file |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
actionPlanKindName
String | the kind of the action_plan |
actionPlanKindID
ID | the kind of the action_plan |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
title
String! | short title describing the action plan |
description
String | detailed description of remediation steps and objectives |
dueDate
Time | due date of the action plan |
completedAt
Time | timestamp when the action plan was completed |
priority
ActionPlanPriority | priority of the action plan |
requiresApproval
Boolean! | indicates if the action plan requires explicit approval before closure |
blocked
Boolean! | true when the action plan is currently blocked |
blockerReason
String | context on why the action plan is blocked |
metadata
Map | additional structured metadata for the action plan |
rawPayload
Map | raw payload received from the integration for auditing and troubleshooting |
source
String | source of the action plan |
approver
Group | the group of users who are responsible for approving the action_plan |
delegate
Group | temporary delegates for the action_plan, used for temporary approval |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
actionPlanKind
CustomTypeEnum | |
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
file
File | |
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this actionPlan has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this actionPlan has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this actionPlan (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this actionPlan across all workflow instances Arguments |
ActionPlanBulkCreatePayload
Return response for createBulkActionPlan mutation
Fields
ActionPlanBulkDeletePayload
Return response for deleteBulkActionPlan mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted actionPlan IDs |
ActionPlanBulkUpdatePayload
Return response for updateBulkActionPlan mutation
Fields
| Name | Description |
|---|
actionPlans
[ActionPlan!] | Updated actionPlans |
updatedIDs
[ID!] | IDs of the updated actionPlans |
ActionPlanConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ActionPlanEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ActionPlanCreatePayload
Return response for createActionPlan mutation
Fields
| Name | Description |
|---|
actionPlan
ActionPlan! | Created actionPlan |
ActionPlanDeletePayload
Return response for deleteActionPlan mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted actionPlan ID |
ActionPlanEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
ActionPlan | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ActionPlanUpdatePayload
Return response for updateActionPlan mutation
Fields
| Name | Description |
|---|
actionPlan
ActionPlan! | Updated actionPlan |
APIToken
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
name
String! | the name associated with the token |
token
String! | |
expiresAt
Time | when the token expires |
description
String | a description of the token's purpose |
scopes
[String!] | |
lastUsedAt
Time | |
isActive
Boolean | whether the token is active |
revokedReason
String | the reason the token was revoked |
revokedBy
String | the user who revoked the token |
revokedAt
Time | when the token was revoked |
ssoAuthorizations
SSOAuthorizationMap | SSO verification time for the owning organization |
owner
Organization | |
APITokenBulkCreatePayload
Return response for createBulkAPIToken mutation
Fields
APITokenBulkDeletePayload
Return response for deleteBulkAPIToken mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted apiToken IDs |
APITokenBulkUpdatePayload
Return response for updateBulkAPIToken mutation
Fields
| Name | Description |
|---|
apiTokens
[APIToken!] | Updated apiTokens |
updatedIDs
[ID!] | IDs of the updated apiTokens |
APITokenConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[APITokenEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
APITokenCreatePayload
Return response for createAPIToken mutation
Fields
| Name | Description |
|---|
apiToken
APIToken! | Created apiToken |
APITokenDeletePayload
Return response for deleteAPIToken mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted apiToken ID |
APITokenEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
APIToken | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
APITokenUpdatePayload
Return response for updateAPIToken mutation
Fields
| Name | Description |
|---|
apiToken
APIToken! | Updated apiToken |
Assessment
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
name
String! | the name of the assessment, e.g. cloud providers, marketing team |
assessmentType
AssessmentAssessmentType! | |
templateID
ID | the template id associated with this assessment. You can either provide this alone or provide both the jsonconfig and uischema |
jsonconfig
Map | the jsonschema object of the questionnaire. If not provided it will be inherited from the template. |
uischema
Map | the uischema for the template to render in the UI. If not provided, it will be inherited from the template |
responseDueDuration
Int | the duration in seconds that the user has to complete the assessment response, defaults to 7 days |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
template
Template | |
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
assessmentResponses
AssessmentResponseConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentResponseOrder!] | Ordering options for AssessmentResponses returned from the connection. | where
AssessmentResponseWhereInput | Filtering options for AssessmentResponses returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
AssessmentBulkDeletePayload
Return response for deleteBulkAssessment mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted assessment IDs |
AssessmentConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[AssessmentEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
AssessmentCreatePayload
Return response for createAssessment mutation
Fields
| Name | Description |
|---|
assessment
Assessment! | Created assessment |
AssessmentDeletePayload
Return response for deleteAssessment mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted assessment ID |
AssessmentEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Assessment | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
AssessmentResponse
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
assessmentID
ID! | the assessment this response is for |
isTest
Boolean! | whether this assessment response is for a test send |
campaignID
ID | the campaign this response is associated with |
identityHolderID
ID | the identity holder record for the recipient |
entityID
ID | the entity associated with this assessment response |
email
String! | the email address of the recipient |
sendAttempts
Int! | the number of attempts made to perform email send to the recipient about this assessment, maximum of 5 |
emailDeliveredAt
Time | when the assessment email was delivered to the recipient |
emailOpenedAt
Time | when the assessment email was opened by the recipient |
emailClickedAt
Time | when a link in the assessment email was clicked by the recipient |
emailOpenCount
Int | the number of times the assessment email was opened |
emailClickCount
Int | the number of link clicks for the assessment email |
lastEmailEventAt
Time | the most recent email event timestamp for this assessment response |
emailMetadata
Map | additional metadata about email delivery events |
status
AssessmentResponseAssessmentResponseStatus! | the current status of the assessment for this user |
assignedAt
Time! | when the assessment was assigned to the user |
startedAt
Time! | when the user started the assessment |
completedAt
Time | when the user completed the assessment |
dueDate
Time | when the assessment response is due |
documentDataID
ID | the document containing the user's response data |
isDraft
Boolean! | is this a draft response? can the user resume from where they left? |
owner
Organization | |
assessment
Assessment! | |
campaign
Campaign | |
identityHolder
IdentityHolder | |
entity
Entity | |
document
DocumentData | |
AssessmentResponseConnection
A connection to a list of items.
Fields
AssessmentResponseCreatePayload
Return response for createAssessmentResponse mutation
Fields
AssessmentResponseDeletePayload
Return response for deleteAssessmentResponse mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted assessmentResponse ID |
AssessmentResponseEdge
An edge in a connection.
Fields
AssessmentUpdatePayload
Return response for updateAssessment mutation
Fields
| Name | Description |
|---|
assessment
Assessment! | Updated assessment |
Asset
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
internalOwner
String | the internal owner for the asset when no user or group is linked |
internalOwnerUserID
ID | the internal owner user id for the asset |
internalOwnerGroupID
ID | the internal owner group id for the asset |
assetSubtypeName
String | the subtype of the asset |
assetSubtypeID
ID | the subtype of the asset |
assetDataClassificationName
String | the data_classification of the asset |
assetDataClassificationID
ID | the data_classification of the asset |
environmentName
String | the environment of the asset |
environmentID
ID | the environment of the asset |
scopeName
String | the scope of the asset |
scopeID
ID | the scope of the asset |
accessModelName
String | the access_model of the asset |
accessModelID
ID | the access_model of the asset |
encryptionStatusName
String | the encryption_status of the asset |
encryptionStatusID
ID | the encryption_status of the asset |
securityTierName
String | the security_tier of the asset |
securityTierID
ID | the security_tier of the asset |
criticalityName
String | the criticality of the asset |
criticalityID
ID | the criticality of the asset |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
assetType
AssetAssetType! | the type of the asset, e.g. technology, domain, device, etc |
name
String! | the name of the asset, e.g. matts computer, office router, IP address, etc |
displayName
String | the display name of the asset |
description
String | |
identifier
String | unique identifier like domain, device id, etc |
website
String | the website of the asset, if applicable |
physicalLocation
String | physical location of the asset, if applicable |
region
String | the region where the asset operates or is hosted |
containsPii
Boolean | whether the asset stores or processes PII |
sourceType
AssetSourceType! | the source of the asset record, e.g., manual, discovered, imported, api |
sourcePlatformID
ID | the platform that sourced the asset record |
sourceIdentifier
String | the identifier used by the source platform for the asset |
costCenter
String | cost center associated with the asset |
estimatedMonthlyCost
Float | estimated monthly cost for the asset |
purchaseDate
DateTime | purchase date for the asset |
cpe
String | the CPE (Common Platform Enumeration) of the asset, if applicable |
categories
[String!] | the categories of the asset, e.g. web server, database, etc |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalOwnerUser
User | |
internalOwnerGroup
Group | |
assetSubtype
CustomTypeEnum | |
assetDataClassification
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
accessModel
CustomTypeEnum | |
encryptionStatus
CustomTypeEnum | |
securityTier
CustomTypeEnum | |
criticality
CustomTypeEnum | |
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
outOfScopePlatforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
sourcePlatform
Platform | |
connectedAssets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
connectedFrom
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
AssetBulkCreatePayload
Return response for createBulkAsset mutation
Fields
| Name | Description |
|---|
assets
[Asset!] | Created assets |
AssetBulkDeletePayload
Return response for deleteBulkAsset mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted asset IDs |
AssetBulkUpdatePayload
Return response for updateBulkAsset mutation
Fields
| Name | Description |
|---|
assets
[Asset!] | Updated assets |
updatedIDs
[ID!] | IDs of the updated assets |
AssetConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[AssetEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
AssetCreatePayload
Return response for createAsset mutation
Fields
| Name | Description |
|---|
asset
Asset! | Created asset |
AssetDeletePayload
Return response for deleteAsset mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted asset ID |
AssetEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Asset | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
AssetUpdatePayload
Return response for updateAsset mutation
Fields
| Name | Description |
|---|
asset
Asset! | Updated asset |
BulkUpdateStatusPayload
Return response for approveNDARequests or denyNDARequests mutation
Fields
| Name | Description |
|---|
totalUpdated
Int! | Updated nda request IDs |
Campaign
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
internalOwner
String | the internal owner for the campaign when no user or group is linked |
internalOwnerUserID
ID | the internal owner user id for the campaign |
internalOwnerGroupID
ID | the internal owner group id for the campaign |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
name
String! | the name of the campaign |
description
String | the description of the campaign |
campaignType
CampaignCampaignType! | the type of campaign |
status
CampaignCampaignStatus! | the status of the campaign |
isActive
Boolean! | whether the campaign is active |
scheduledAt
DateTime | when the campaign is scheduled to start |
launchedAt
DateTime | when the campaign was launched |
completedAt
DateTime | when the campaign completed |
dueDate
DateTime | when responses are due for the campaign |
isRecurring
Boolean! | whether the campaign recurs on a schedule |
recurrenceFrequency
CampaignFrequency | the recurrence cadence for the campaign |
recurrenceInterval
Int | the recurrence interval for the campaign, combined with the recurrence frequency |
recurrenceCron
String | cron schedule to run the campaign in cron 6-field syntax, e.g. 0 0 0 * * * |
recurrenceTimezone
String | timezone used for the recurrence schedule |
lastRunAt
DateTime | when the campaign was last executed |
nextRunAt
DateTime | when the campaign is scheduled to run next |
recurrenceEndAt
DateTime | when the recurring campaign should stop running |
recipientCount
Int | the number of recipients targeted by the campaign |
resendCount
Int | the number of times campaign notifications were resent |
lastResentAt
DateTime | when campaign notifications were last resent |
templateID
ID | the template associated with the campaign |
entityID
ID | the entity associated with the campaign |
assessmentID
ID | the assessment associated with the campaign |
metadata
Map | additional metadata about the campaign |
emailBrandingID
ID | the email branding associated with the campaign |
emailTemplateID
ID | the email template associated with the campaign |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalOwnerUser
User | |
internalOwnerGroup
Group | |
assessment
Assessment | |
template
Template | |
emailBranding
EmailBranding | |
emailTemplate
EmailTemplate | |
entity
Entity | |
campaignTargets
CampaignTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignTargetOrder!] | Ordering options for CampaignTargets returned from the connection. | where
CampaignTargetWhereInput | Filtering options for CampaignTargets returned from the connection. |
|
assessmentResponses
AssessmentResponseConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentResponseOrder!] | Ordering options for AssessmentResponses returned from the connection. | where
AssessmentResponseWhereInput | Filtering options for AssessmentResponses returned from the connection. |
|
contacts
ContactConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ContactOrder!] | Ordering options for Contacts returned from the connection. | where
ContactWhereInput | Filtering options for Contacts returned from the connection. |
|
users
UserConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[UserOrder!] | Ordering options for Users returned from the connection. | where
UserWhereInput | Filtering options for Users returned from the connection. |
|
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this campaign has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this campaign has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this campaign (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this campaign across all workflow instances Arguments |
CampaignBulkCreatePayload
Return response for createBulkCampaign mutation
Fields
CampaignConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[CampaignEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
CampaignCreatePayload
Return response for createCampaign mutation
Fields
| Name | Description |
|---|
campaign
Campaign! | Created campaign |
CampaignCreateWithTargetsPayload
Return response for createCampaignWithTargets mutation
Fields
CampaignDeletePayload
Return response for deleteCampaign mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted campaign ID |
CampaignEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Campaign | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
CampaignLaunchPayload
Return response for launchCampaign mutation
Fields
| Name | Description |
|---|
campaign
Campaign! | Updated campaign |
queuedCount
Int! | Number of targets queued for send |
skippedCount
Int! | Number of targets skipped |
CampaignTarget
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
campaignID
ID! | the campaign this target belongs to |
contactID
ID | the contact associated with the campaign target |
userID
ID | the user associated with the campaign target |
groupID
ID | the group associated with the campaign target |
email
String! | the email address targeted by the campaign |
fullName
String | the name of the campaign target, if known |
status
CampaignTargetAssessmentResponseStatus! | the delivery or response status for the campaign target |
sentAt
DateTime | when the campaign target was last sent a request |
completedAt
DateTime | when the campaign target completed the request |
metadata
Map | additional metadata about the campaign target |
owner
Organization | |
campaign
Campaign! | |
contact
Contact | |
user
User | |
group
Group | |
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this campaignTarget has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this campaignTarget has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this campaignTarget (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this campaignTarget across all workflow instances Arguments |
CampaignTargetBulkCreatePayload
Return response for createBulkCampaignTarget mutation
Fields
CampaignTargetConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[CampaignTargetEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
CampaignTargetCreatePayload
Return response for createCampaignTarget mutation
Fields
CampaignTargetDeletePayload
Return response for deleteCampaignTarget mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted campaignTarget ID |
CampaignTargetEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
CampaignTarget | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
CampaignTargetUpdatePayload
Return response for updateCampaignTarget mutation
Fields
CampaignTestEmailPayload
Return response for sendCampaignTestEmail mutation
Fields
| Name | Description |
|---|
campaign
Campaign! | Campaign used for the test send |
queuedCount
Int! | Number of emails queued for send |
skippedCount
Int! | Number of emails skipped |
CampaignUpdatePayload
Return response for updateCampaign mutation
Fields
| Name | Description |
|---|
campaign
Campaign! | Updated campaign |
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
fullName
String | the full name of the contact |
title
String | the title of the contact |
company
String | the company of the contact |
email
String | the email of the contact |
phoneNumber
String | the phone number of the contact |
address
String | the address of the contact |
status
ContactUserStatus! | status of the contact |
owner
Organization | |
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignTargets
CampaignTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignTargetOrder!] | Ordering options for CampaignTargets returned from the connection. | where
CampaignTargetWhereInput | Filtering options for CampaignTargets returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
Return response for createBulkContact mutation
Fields
| Name | Description |
|---|
contacts
[Contact!] | Created contacts |
Return response for deleteBulkContact mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted contact IDs |
Return response for updateBulkContact mutation
Fields
| Name | Description |
|---|
contacts
[Contact!] | Updated contacts |
updatedIDs
[ID!] | IDs of the updated contacts |
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ContactEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
Return response for createContact mutation
Fields
| Name | Description |
|---|
contact
Contact! | Created contact |
Return response for deleteContact mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted contact ID |
An edge in a connection.
Fields
| Name | Description |
|---|
node
Contact | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
Return response for updateContact mutation
Fields
| Name | Description |
|---|
contact
Contact! | Updated contact |
Control
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
title
String | human readable title of the control for quick identification |
description
String | description of what the control is supposed to accomplish |
descriptionJSON
[Any!] | structured details of the control in JSON format |
aliases
[String!] | additional names (ref_codes) for the control |
referenceID
String | internal reference id of the control, can be used for internal tracking |
auditorReferenceID
String | external auditor id of the control, can be used to map to external audit partner mappings |
responsiblePartyID
ID | the id of the party responsible for the control, usually used when the control is implemented by a third party |
status
ControlControlStatus | status of the control |
implementationStatus
ControlControlImplementationStatus | OSCAL-aligned implementation status of the control |
implementationDescription
String | narrative describing current implementation state for OSCAL export |
source
ControlControlSource | source of the control, e.g. framework, template, custom, etc. |
referenceFramework
String | the reference framework for the control if it came from a standard, empty if not associated with a standard |
referenceFrameworkRevision
String | the reference framework revision for the control if it came from a standard, empty if not associated with a standard, allows for pulling in updates when the standard is updated |
category
String | category of the control |
categoryID
String | category id of the control |
subcategory
String | subcategory of the control |
mappedCategories
[String!] | mapped categories of the control to other standards |
assessmentObjectives
[AssessmentObjective!] | objectives of the audit assessment for the control |
assessmentMethods
[AssessmentMethod!] | methods used to verify the control implementation during an audit |
controlQuestions
[String!] | questions to ask to verify the control |
implementationGuidance
[ImplementationGuidance!] | implementation guidance for the control |
exampleEvidence
[ExampleEvidence!] | examples of evidence for the control |
references
[Reference!] | references for the control |
testingProcedures
[TestingProcedures!] | reference steps to take to test the control |
evidenceRequests
[EvidenceRequests!] | list of common evidence requests for the control |
controlOwnerID
ID | the id of the group that owns the control |
delegateID
ID | the id of the group that is temporarily delegated to own the control |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
controlKindName
String | the kind of the control |
controlKindID
ID | the kind of the control |
environmentName
String | the environment of the control |
environmentID
ID | the environment of the control |
scopeName
String | the scope of the control |
scopeID
ID | the scope of the control |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
refCode
String! | the unique reference code for the control |
standardID
ID | the id of the standard that the control belongs to, if applicable |
trustCenterVisibility
ControlTrustCenterControlVisibility | visibility of the control on the trust center, controls the publishing state for trust center display |
isTrustCenterControl
Boolean | indicates the control is derived from the trust center standard, set by the system during control clone |
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
controlOwner
Group | the group of users who are responsible for the control, will be assigned tasks, approval, etc. |
delegate
Group | temporary delegate for the control, used for temporary control ownership |
responsibleParty
Entity | the entity who is responsible for the control implementation when it is a third party |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
controlKind
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
standard
Standard | |
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
scheduledJobs
ScheduledJobConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScheduledJobOrder!] | Ordering options for ScheduledJobs returned from the connection. | where
ScheduledJobWhereInput | Filtering options for ScheduledJobs returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
controlMappings
FindingControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingControlOrder!] | Ordering options for FindingControls returned from the connection. | where
FindingControlWhereInput | Filtering options for FindingControls returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this control has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this control has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this control (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this control across all workflow instances Arguments |
ControlBulkCreatePayload
Return response for createBulkControl mutation
Fields
| Name | Description |
|---|
controls
[Control!] | Created controls |
ControlBulkDeletePayload
Return response for deleteBulkControl mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted control IDs |
ControlBulkUpdatePayload
Return response for updateBulkControl mutation
Fields
| Name | Description |
|---|
controls
[Control!] | Updated controls |
updatedIDs
[ID!] | IDs of the updated controls |
ControlCategory
Fields
ControlCategoryConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ControlCategoryEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ControlCategoryEdge
An edge in a connection.
Fields
ControlChange
ControlChange describes the diffs for a single control identified by refCode
Fields
| Name | Description |
|---|
refCode
String! | The ref_code of the control |
title
String! | The title of the control at the new revision |
diffs
[ControlFieldDiff!]! | Field-level diffs for this control |
ControlConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ControlEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ControlCreatePayload
Return response for createControl mutation
Fields
| Name | Description |
|---|
control
Control! | Created control |
ControlDeletePayload
Return response for deleteControl mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted control ID |
ControlDiffPayload
ControlDiffPayload contains the field-level diffs between two revisions of all controls under a standard
Fields
| Name | Description |
|---|
standardID
ID! | The standard ID being compared |
oldRevision
String! | The base revision |
newRevision
String! | The target revision |
changes
[ControlChange!]! | Per-control changes between the two revisions |
ControlEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Control | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ControlFieldDiff
ControlFieldDiff describes a single field that differs between two control revisions
Fields
| Name | Description |
|---|
field
String! | Field name (snake_case) |
oldValue
Any | Value in the old revision |
newValue
Any | Value in the new revision |
diff
String | Unified diff text when applicable |
ControlGroup
Fields
ControlGroupConnection
Fields
ControlGroupEdge
Fields
ControlImplementation
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
status
ControlImplementationDocumentStatus | status of the %s, e.g. draft, published, archived, etc. |
implementationDate
Time | date the control was implemented |
verified
Boolean | set to true if the control implementation has been verified |
verificationDate
Time | date the control implementation was verified |
details
String | details of the control implementation |
detailsJSON
[Any!] | structured details of the control implementation in JSON format |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
ControlImplementationBulkCreatePayload
Return response for createBulkControlImplementation mutation
Fields
ControlImplementationBulkDeletePayload
Return response for deleteBulkControlImplementation mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted controlImplementation IDs |
ControlImplementationBulkUpdatePayload
Return response for updateBulkControlImplementation mutation
Fields
| Name | Description |
|---|
controlImplementations
[ControlImplementation!] | Updated controlImplementations |
updatedIDs
[ID!] | IDs of the updated controlImplementations |
ControlImplementationConnection
A connection to a list of items.
Fields
ControlImplementationCreatePayload
Return response for createControlImplementation mutation
Fields
ControlImplementationDeletePayload
Return response for deleteControlImplementation mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted controlImplementation ID |
ControlImplementationEdge
An edge in a connection.
Fields
ControlImplementationUpdatePayload
Return response for updateControlImplementation mutation
Fields
ControlObjective
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
revision
String | revision of the object as a semver (e.g. v1.0.0), by default any update will bump the patch version, unless the revision_bump field is set |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the name of the control objective |
desiredOutcome
String | the desired outcome or target of the control objective |
desiredOutcomeJSON
[Any!] | structured details of the control objective in JSON format |
status
ControlObjectiveObjectiveStatus | status of the control objective |
source
ControlObjectiveControlSource | source of the control, e.g. framework, template, custom, etc. |
controlObjectiveType
String | type of the control objective e.g. compliance, financial, operational, etc. |
category
String | category of the control |
subcategory
String | subcategory of the control |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
ControlObjectiveBulkCreatePayload
Return response for createBulkControlObjective mutation
Fields
ControlObjectiveBulkDeletePayload
Return response for deleteBulkControlObjective mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted controlObjective IDs |
ControlObjectiveBulkUpdatePayload
Return response for updateBulkControlObjective mutation
Fields
| Name | Description |
|---|
controlObjectives
[ControlObjective!] | Updated controlObjectives |
updatedIDs
[ID!] | IDs of the updated controlObjectives |
ControlObjectiveConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ControlObjectiveEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ControlObjectiveCreatePayload
Return response for createControlObjective mutation
Fields
ControlObjectiveDeletePayload
Return response for deleteControlObjective mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted controlObjective ID |
ControlObjectiveEdge
An edge in a connection.
Fields
ControlObjectiveUpdatePayload
Return response for updateControlObjective mutation
Fields
ControlUpdatePayload
Return response for updateControl mutation
Fields
| Name | Description |
|---|
control
Control! | Updated control |
CustomDomain
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
cnameRecord
String! | the name of the custom domain |
mappableDomainID
ID! | The mappable domain id that this custom domain maps to |
dnsVerificationID
ID | The ID of the dns verification record |
trustCenterID
String | the ID of the trust center the domain belongs to, if applicable |
owner
Organization | |
mappableDomain
MappableDomain! | |
dnsVerification
DNSVerification | |
CustomDomainBulkCreatePayload
Return response for createBulkCustomDomain mutation
Fields
CustomDomainBulkDeletePayload
Return response for deleteBulkCustomDomain mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted customDomain IDs |
CustomDomainBulkUpdatePayload
Return response for updateBulkCustomDomain mutation
Fields
| Name | Description |
|---|
customDomains
[CustomDomain!] | Updated customDomains |
updatedIDs
[ID!] | IDs of the updated customDomains |
CustomDomainConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[CustomDomainEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
CustomDomainCreatePayload
Return response for createCustomDomain mutation
Fields
CustomDomainDeletePayload
Return response for deleteCustomDomain mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted customDomain ID |
CustomDomainEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
CustomDomain | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
CustomDomainUpdatePayload
Return response for updateCustomDomain mutation
Fields
CustomDomainValidatePayload
Return response for validateCustomDomain mutation
Fields
| Name | Description |
|---|
customDomain
CustomDomain! | CustomDomain that validation was triggered for |
CustomTypeEnum
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
objectType
String! | the kind of object the type applies to, for example task, leave empty for global enums |
field
String! | the field on the object the type applies to, for example kind or category |
name
String! | The name of the enum value, for example evidence request |
description
String | The description of the custom type |
color
String | The color of the tag definition in hex format |
icon
String | The icon of the custom type enum in SVG format |
owner
Organization | |
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
riskCategories
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
CustomTypeEnumBulkCreatePayload
Return response for createBulkCustomTypeEnum mutation
Fields
CustomTypeEnumConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[CustomTypeEnumEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
CustomTypeEnumCreatePayload
Return response for createCustomTypeEnum mutation
Fields
CustomTypeEnumDeletePayload
Return response for deleteCustomTypeEnum mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted customTypeEnum ID |
CustomTypeEnumEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
CustomTypeEnum | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
CustomTypeEnumUpdatePayload
Return response for updateCustomTypeEnum mutation
Fields
DirectoryAccount
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
environmentName
String | the environment of the directory_account |
environmentID
ID | the environment of the directory_account |
scopeName
String | the scope of the directory_account |
scopeID
ID | the scope of the directory_account |
integrationID
ID | optional integration that owns this directory account when sourced by an integration |
directorySyncRunID
ID | optional sync run that produced this snapshot |
platformID
ID | optional platform associated with this directory account |
identityHolderID
ID | deduplicated identity holder linked to this directory account |
directoryName
String | directory source label set by the integration (e.g. googleworkspace, github, slack) |
externalID
String! | stable identifier from the directory system |
secondaryKey
String | optional secondary identifier such as Azure immutable ID |
canonicalEmail
String | lower-cased primary email address, if present |
displayName
String | provider supplied display name |
avatarRemoteURL
String | URL of the avatar supplied by the directory provider |
avatarLocalFileID
ID | local avatar file identifier, takes precedence over avatar_remote_url |
avatarUpdatedAt
Time | time the directory account avatar was last updated |
givenName
String | first name reported by the provider |
familyName
String | last name reported by the provider |
jobTitle
String | title captured at sync time |
department
String | department captured at sync time |
organizationUnit
String | organizational unit or OU path the account lives under |
accountType
DirectoryAccountDirectoryAccountType | type of principal represented in the directory |
status
DirectoryAccountDirectoryAccountStatus! | lifecycle status returned by the directory |
mfaState
DirectoryAccountDirectoryAccountMFAState! | multi-factor authentication state reported by the directory |
lastSeenIP
String | last IP address observed by the provider, if any |
lastLoginAt
Time | timestamp of the most recent login reported by the provider |
observedAt
Time! | time when this snapshot was recorded |
profileHash
String! | hash of the normalized profile payload for change detection |
profile
Map | flattened attribute bag used for filtering/diffing |
rawProfileFileID
String | object storage file identifier that holds the raw upstream payload |
sourceVersion
String | cursor or ETag supplied by the source system for auditing |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integration
Integration | integration that owns this directory account |
directorySyncRun
DirectorySyncRun | sync run that produced this snapshot |
platform
Platform | platform associated with this directory account |
identityHolder
IdentityHolder | identity holder linked to this directory account |
avatarFile
File | local avatar file for the directory account |
groups
DirectoryGroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryGroupOrder!] | Ordering options for DirectoryGroups returned from the connection. | where
DirectoryGroupWhereInput | Filtering options for DirectoryGroups returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
memberships
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
DirectoryAccountBulkCreatePayload
Return response for createBulkDirectoryAccount mutation
Fields
DirectoryAccountConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DirectoryAccountEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DirectoryAccountCreatePayload
Return response for createDirectoryAccount mutation
Fields
DirectoryAccountDeletePayload
Return response for deleteDirectoryAccount mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted directoryAccount ID |
DirectoryAccountEdge
An edge in a connection.
Fields
DirectoryAccountUpdatePayload
Return response for updateDirectoryAccount mutation
Fields
DirectoryGroup
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
environmentName
String | the environment of the directory_group |
environmentID
ID | the environment of the directory_group |
scopeName
String | the scope of the directory_group |
scopeID
ID | the scope of the directory_group |
integrationID
ID! | integration that owns this directory group |
platformID
ID | optional platform associated with this directory group |
directorySyncRunID
ID! | sync run that produced this snapshot |
externalID
String! | stable identifier from the directory system |
email
String | primary group email address, when applicable |
displayName
String | directory supplied display name |
description
String | free-form description captured at sync time |
classification
DirectoryGroupDirectoryGroupClassification! | provider classification such as security, distribution, or dynamic |
status
DirectoryGroupDirectoryGroupStatus! | lifecycle status reported by the directory |
externalSharingAllowed
Boolean | true when directory settings allow sharing outside the tenant |
memberCount
Int | member count reported by the directory |
observedAt
Time! | time when this snapshot was recorded |
profileHash
String! | hash of the normalized payload for diffing |
profile
Map | flattened attribute bag used for filtering/diffing |
rawProfileFileID
String | object storage file identifier containing the raw upstream payload |
sourceVersion
String | cursor or ETag supplied by the source system for auditing |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integration
Integration! | integration that owns this directory group |
directorySyncRun
DirectorySyncRun! | sync run that produced this snapshot |
platform
Platform | platform associated with this directory group |
accounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
members
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
DirectoryGroupBulkCreatePayload
Return response for createBulkDirectoryGroup mutation
Fields
DirectoryGroupConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DirectoryGroupEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DirectoryGroupCreatePayload
Return response for createDirectoryGroup mutation
Fields
DirectoryGroupDeletePayload
Return response for deleteDirectoryGroup mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted directoryGroup ID |
DirectoryGroupEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
DirectoryGroup | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
DirectoryGroupUpdatePayload
Return response for updateDirectoryGroup mutation
Fields
DirectoryMembership
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
ownerID
ID | the organization id that owns the object |
environmentName
String | the environment of the directory_membership |
environmentID
ID | the environment of the directory_membership |
scopeName
String | the scope of the directory_membership |
scopeID
ID | the scope of the directory_membership |
integrationID
ID! | integration that owns this directory membership |
platformID
ID | optional platform associated with this directory membership |
directorySyncRunID
ID! | sync run that produced this snapshot |
directoryAccountID
ID! | directory account participating in this membership |
directoryGroupID
ID! | directory group associated with this membership |
role
DirectoryMembershipDirectoryMembershipRole | membership role reported by the provider |
source
String | mechanism used to populate the membership (api, scim, csv, etc) |
firstSeenAt
Time | first time the membership was detected |
lastSeenAt
Time | most recent time the membership was detected |
observedAt
Time! | time when this record was created |
lastConfirmedRunID
String | sync run identifier that most recently confirmed this membership |
metadata
Map | raw metadata associated with this membership from the provider |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integration
Integration! | integration that owns this directory membership |
directorySyncRun
DirectorySyncRun! | sync run that produced this snapshot |
platform
Platform | platform associated with this directory membership |
directoryAccount
DirectoryAccount! | |
directoryGroup
DirectoryGroup! | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
DirectoryMembershipBulkCreatePayload
Return response for createBulkDirectoryMembership mutation
Fields
DirectoryMembershipConnection
A connection to a list of items.
Fields
DirectoryMembershipCreatePayload
Return response for createDirectoryMembership mutation
Fields
DirectoryMembershipDeletePayload
Return response for deleteDirectoryMembership mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted directoryMembership ID |
DirectoryMembershipEdge
An edge in a connection.
Fields
DirectoryMembershipUpdatePayload
Return response for updateDirectoryMembership mutation
Fields
DirectorySyncRun
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
ownerID
ID | the organization id that owns the object |
environmentName
String | the environment of the directory_sync_run |
environmentID
ID | the environment of the directory_sync_run |
scopeName
String | the scope of the directory_sync_run |
scopeID
ID | the scope of the directory_sync_run |
integrationID
ID! | integration this sync run executed for |
platformID
ID | optional platform associated with this sync run |
status
DirectorySyncRunDirectorySyncRunStatus! | current state of the sync run |
startedAt
Time! | time the sync started |
completedAt
Time | time the sync finished |
sourceCursor
String | cursor or checkpoint returned by the provider for the next run |
fullCount
Int! | total records processed during this run |
deltaCount
Int! | number of records that changed compared to the prior run |
error
String | serialized error information when the run failed |
rawManifestFileID
String | object storage file identifier for the manifest captured during the run |
stats
Map | additional provider-specific stats for the run |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integration
Integration! | integration that executed this sync run |
platform
Platform | platform associated with this sync run |
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
directoryGroups
DirectoryGroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryGroupOrder!] | Ordering options for DirectoryGroups returned from the connection. | where
DirectoryGroupWhereInput | Filtering options for DirectoryGroups returned from the connection. |
|
directoryMemberships
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
DirectorySyncRunBulkCreatePayload
Return response for createBulkDirectorySyncRun mutation
Fields
DirectorySyncRunConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DirectorySyncRunEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DirectorySyncRunCreatePayload
Return response for createDirectorySyncRun mutation
Fields
DirectorySyncRunDeletePayload
Return response for deleteDirectorySyncRun mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted directorySyncRun ID |
DirectorySyncRunEdge
An edge in a connection.
Fields
DirectorySyncRunUpdatePayload
Return response for updateDirectorySyncRun mutation
Fields
Discussion
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
externalID
String | the unique discussion identifier from external system, e.g. plate discussion id, only required if synced from external system |
isResolved
Boolean! | whether the discussion is resolved |
owner
Organization | |
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
control
Control | |
subcontrol
Subcontrol | |
procedure
Procedure | |
risk
Risk | |
internalPolicy
InternalPolicy | |
DiscussionBulkCreatePayload
Return response for createBulkDiscussion mutation
Fields
DiscussionConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DiscussionEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DiscussionCreatePayload
Return response for createDiscussion mutation
Fields
| Name | Description |
|---|
discussion
Discussion! | Created discussion |
DiscussionDeletePayload
Return response for deleteDiscussion mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted discussion ID |
DiscussionEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Discussion | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
DiscussionUpdatePayload
Return response for updateDiscussion mutation
Fields
| Name | Description |
|---|
discussion
Discussion! | Updated discussion |
DNSVerification
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
cloudflareHostnameID
String! | The ID of the custom domain in cloudflare |
dnsTxtRecord
String! | the name of the dns txt record |
dnsTxtValue
String! | the expected value of the dns txt record |
dnsVerificationStatus
DNSVerificationDNSVerificationStatus! | Status of the domain verification |
dnsVerificationStatusReason
String | Reason of the dns verification status, for giving the user diagnostic info |
acmeChallengePath
String | Path under /.well-known/acme-challenge/ to serve the ACME challenge |
expectedAcmeChallengeValue
String | the expected value of the acme challenge record |
acmeChallengeStatus
DNSVerificationSSLVerificationStatus! | Status of the ACME challenge validation |
acmeChallengeStatusReason
String | Reason of the ACME status, for giving the user diagnostic info |
owner
Organization | |
customDomains
CustomDomainConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CustomDomainOrder!] | Ordering options for CustomDomains returned from the connection. | where
CustomDomainWhereInput | Filtering options for CustomDomains returned from the connection. |
|
DNSVerificationBulkCreatePayload
Return response for createBulkDNSVerification mutation
Fields
DNSVerificationBulkDeletePayload
Return response for deleteBulkDNSVerification mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted dnsVerification IDs |
DNSVerificationBulkUpdatePayload
Return response for updateBulkDNSVerification mutation
Fields
| Name | Description |
|---|
dnsVerifications
[DNSVerification!] | Updated dnsVerifications |
updatedIDs
[ID!] | IDs of the updated dnsVerifications |
DNSVerificationConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DNSVerificationEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DNSVerificationCreatePayload
Return response for createDNSVerification mutation
Fields
DNSVerificationDeletePayload
Return response for deleteDNSVerification mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted dnsVerification ID |
DNSVerificationEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
DNSVerification | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
DNSVerificationUpdatePayload
Return response for updateDNSVerification mutation
Fields
DocumentData
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
environmentName
String | the environment of the document |
environmentID
ID | the environment of the document |
scopeName
String | the scope of the document |
scopeID
ID | the scope of the document |
templateID
ID | the template id of the document |
data
Map! | the json data of the document |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
template
Template | |
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
DocumentDataBulkCreatePayload
Return response for createBulkDocumentData mutation
Fields
DocumentDataBulkDeletePayload
Return response for deleteBulkDocumentData mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted documentData IDs |
DocumentDataBulkUpdatePayload
Return response for updateBulkDocumentData mutation
Fields
| Name | Description |
|---|
documentData
[DocumentData!] | Updated documentDatas |
updatedIDs
[ID!] | IDs of the updated documentDatas |
DocumentDataConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[DocumentDataEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
DocumentDataCreatePayload
Return response for createDocumentData mutation
Fields
DocumentDataDeletePayload
Return response for deleteDocumentData mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted documentData ID |
DocumentDataEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
DocumentData | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
DocumentDataUpdatePayload
Return response for updateDocumentData mutation
Fields
EmailBranding
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
name
String! | friendly name for this email branding configuration |
brandName
String | brand name displayed in templates |
logoRemoteURL
String | URL of the brand logo for emails |
primaryColor
String | primary brand color for emails |
secondaryColor
String | secondary brand color for emails |
backgroundColor
String | background color for emails |
textColor
String | text color for emails |
buttonColor
String | button background color for emails |
buttonTextColor
String | button text color for emails |
linkColor
String | link color for emails |
fontFamily
EmailBrandingFont | font family for emails |
isDefault
Boolean | whether this is the default email branding for the organization |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
emailTemplates
EmailTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailTemplateOrder!] | Ordering options for EmailTemplates returned from the connection. | where
EmailTemplateWhereInput | Filtering options for EmailTemplates returned from the connection. |
|
EmailBrandingBulkCreatePayload
Return response for createBulkEmailBranding mutation
Fields
EmailBrandingBulkDeletePayload
Return response for deleteBulkEmailBranding mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted emailBranding IDs |
EmailBrandingBulkUpdatePayload
Return response for updateBulkEmailBranding mutation
Fields
| Name | Description |
|---|
emailBrandings
[EmailBranding!] | Updated emailBrandings |
updatedIDs
[ID!] | IDs of the updated emailBrandings |
EmailBrandingConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EmailBrandingEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EmailBrandingCreatePayload
Return response for createEmailBranding mutation
Fields
EmailBrandingDeletePayload
Return response for deleteEmailBranding mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted emailBranding ID |
EmailBrandingEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
EmailBranding | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EmailBrandingUpdatePayload
Return response for updateEmailBranding mutation
Fields
EmailTemplate
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
key
String! | stable identifier for the template |
name
String! | display name for the template |
description
String | description of the template |
format
EmailTemplateNotificationTemplateFormat! | template format for rendering |
locale
String! | locale for the template, e.g. en-US |
subjectTemplate
String | subject template for email notifications |
preheaderTemplate
String | preheader/preview text template for email notifications |
bodyTemplate
String | body template for the email |
textTemplate
String | plain text fallback template for the email |
jsonconfig
Map | jsonschema for template data requirements |
uischema
Map | uischema for a template builder |
metadata
Map | additional template metadata |
active
Boolean! | whether the template is active |
version
Int! | template version |
emailBrandingID
ID | email branding configuration to apply for this template |
integrationID
ID | integration used to deliver emails for this template |
workflowDefinitionID
ID | workflow definition associated with this template |
workflowInstanceID
ID | workflow instance associated with this template |
owner
Organization | |
emailBranding
EmailBranding | |
integration
Integration | |
workflowDefinition
WorkflowDefinition | |
workflowInstance
WorkflowInstance | |
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
notificationTemplates
NotificationTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NotificationTemplateOrder!] | Ordering options for NotificationTemplates returned from the connection. | where
NotificationTemplateWhereInput | Filtering options for NotificationTemplates returned from the connection. |
|
EmailTemplateBulkCreatePayload
Return response for createBulkEmailTemplate mutation
Fields
EmailTemplateBulkDeletePayload
Return response for deleteBulkEmailTemplate mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted emailTemplate IDs |
EmailTemplateBulkUpdatePayload
Return response for updateBulkEmailTemplate mutation
Fields
| Name | Description |
|---|
emailTemplates
[EmailTemplate!] | Updated emailTemplates |
updatedIDs
[ID!] | IDs of the updated emailTemplates |
EmailTemplateConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EmailTemplateEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EmailTemplateCreatePayload
Return response for createEmailTemplate mutation
Fields
EmailTemplateDeletePayload
Return response for deleteEmailTemplate mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted emailTemplate ID |
EmailTemplateEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
EmailTemplate | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EmailTemplateUpdatePayload
Return response for updateEmailTemplate mutation
Fields
Entity
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
internalOwner
String | the internal owner for the entity when no user or group is linked |
internalOwnerUserID
ID | the internal owner user id for the entity |
internalOwnerGroupID
ID | the internal owner group id for the entity |
reviewedBy
String | who reviewed the entity when no user or group is linked |
reviewedByUserID
ID | the user id that reviewed the entity |
reviewedByGroupID
ID | the group id that reviewed the entity |
lastReviewedAt
DateTime | when the entity was last reviewed |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
entityRelationshipStateName
String | the relationship_state of the entity |
entityRelationshipStateID
ID | the relationship_state of the entity |
entitySecurityQuestionnaireStatusName
String | the security_questionnaire_status of the entity |
entitySecurityQuestionnaireStatusID
ID | the security_questionnaire_status of the entity |
entitySourceTypeName
String | the source_type of the entity |
entitySourceTypeID
ID | the source_type of the entity |
environmentName
String | the environment of the entity |
environmentID
ID | the environment of the entity |
scopeName
String | the scope of the entity |
scopeID
ID | the scope of the entity |
name
String | the name of the entity |
displayName
String | The entity's displayed 'friendly' name |
description
String | An optional description of the entity |
domains
[String!] | domains associated with the entity |
entityTypeID
ID | The type of the entity |
status
EntityEntityStatus | status of the entity |
approvedForUse
Boolean | whether the entity is approved for use |
linkedAssetIds
[String!] | asset identifiers linked to the entity |
hasSoc2
Boolean | whether the entity has an active SOC 2 report |
soc2PeriodEnd
DateTime | SOC 2 reporting period end date |
contractStartDate
DateTime | start date for the entity contract |
contractEndDate
DateTime | end date for the entity contract |
autoRenews
Boolean | whether the contract auto-renews |
terminationNoticeDays
Int | number of days required for termination notice |
annualSpend
Float | annual spend associated with the entity |
spendCurrency
String | the currency of the annual spend |
billingModel
String | billing model for the entity relationship |
renewalRisk
String | renewal risk rating for the entity |
ssoEnforced
Boolean | whether SSO is enforced for the entity |
mfaSupported
Boolean | whether MFA is supported by the entity |
mfaEnforced
Boolean | whether MFA is enforced by the entity |
statusPageURL
String | status page URL for the entity |
providedServices
[String!] | services provided by the entity |
links
[String!] | external links associated with the entity |
riskRating
String | the risk rating label for the entity |
riskScore
Int | the risk score for the entity |
tier
String | the tier classification for the entity |
reviewFrequency
EntityFrequency | the cadence for reviewing the entity |
nextReviewAt
DateTime | when the entity is due for review |
contractRenewalAt
DateTime | when the entity contract is up for renewal |
vendorMetadata
Map | vendor metadata such as additional enrichment info, company size, public, etc. |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalOwnerUser
User | |
internalOwnerGroup
Group | |
reviewedByUser
User | |
reviewedByGroup
Group | |
entityRelationshipState
CustomTypeEnum | |
entitySecurityQuestionnaireStatus
CustomTypeEnum | |
entitySourceType
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
contacts
ContactConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ContactOrder!] | Ordering options for Contacts returned from the connection. | where
ContactWhereInput | Filtering options for Contacts returned from the connection. |
|
documents
DocumentDataConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DocumentDataOrder!] | Ordering options for DocumentDataSlice returned from the connection. | where
DocumentDataWhereInput | Filtering options for DocumentDataSlice returned from the connection. |
|
notes
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
assessmentResponses
AssessmentResponseConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentResponseOrder!] | Ordering options for AssessmentResponses returned from the connection. | where
AssessmentResponseWhereInput | Filtering options for AssessmentResponses returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
subprocessors
SubprocessorConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubprocessorOrder!] | Ordering options for Subprocessors returned from the connection. | where
SubprocessorWhereInput | Filtering options for Subprocessors returned from the connection. |
|
authMethods
CustomTypeEnumConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CustomTypeEnumOrder!] | Ordering options for CustomTypeEnums returned from the connection. | where
CustomTypeEnumWhereInput | Filtering options for CustomTypeEnums returned from the connection. |
|
employerIdentityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
outOfScopePlatforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
sourcePlatforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
entityType
EntityType | |
EntityBulkCreatePayload
Return response for createBulkEntity mutation
Fields
| Name | Description |
|---|
entities
[Entity!] | Created entities |
EntityBulkDeletePayload
Return response for deleteBulkEntity mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted entity IDs |
EntityBulkUpdatePayload
Return response for updateBulkEntity mutation
Fields
| Name | Description |
|---|
entities
[Entity!] | Updated entitys |
updatedIDs
[ID!] | IDs of the updated entitys |
EntityConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EntityEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EntityCreatePayload
Return response for createEntity mutation
Fields
| Name | Description |
|---|
entity
Entity! | Created entity |
EntityDeletePayload
Return response for deleteEntity mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted entity ID |
EntityEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Entity | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EntityType
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the name of the entity |
owner
Organization | |
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
EntityTypeBulkCreatePayload
Return response for createBulkEntityType mutation
Fields
EntityTypeBulkDeletePayload
Return response for deleteBulkEntityType mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted entityType IDs |
EntityTypeBulkUpdatePayload
Return response for updateBulkEntityType mutation
Fields
| Name | Description |
|---|
entityTypes
[EntityType!] | Updated entityTypes |
updatedIDs
[ID!] | IDs of the updated entityTypes |
EntityTypeConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EntityTypeEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EntityTypeCreatePayload
Return response for createEntityType mutation
Fields
| Name | Description |
|---|
entityType
EntityType! | Created entityType |
EntityTypeDeletePayload
Return response for deleteEntityType mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted entityType ID |
EntityTypeEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
EntityType | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EntityTypeUpdatePayload
Return response for updateEntityType mutation
Fields
| Name | Description |
|---|
entityType
EntityType! | Updated entityType |
EntityUpdatePayload
Return response for updateEntity mutation
Fields
| Name | Description |
|---|
entity
Entity! | Updated entity |
Event
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
eventID
String | |
correlationID
String | |
eventType
String! | |
metadata
Map | |
users
UserConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[UserOrder!] | Ordering options for Users returned from the connection. | where
UserWhereInput | Filtering options for Users returned from the connection. |
|
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
organizations
OrganizationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrganizationOrder!] | Ordering options for Organizations returned from the connection. | where
OrganizationWhereInput | Filtering options for Organizations returned from the connection. |
|
invites
InviteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InviteOrder!] | Ordering options for Invites returned from the connection. | where
InviteWhereInput | Filtering options for Invites returned from the connection. |
|
personalAccessTokens
PersonalAccessTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PersonalAccessTokenOrder!] | Ordering options for PersonalAccessTokens returned from the connection. | where
PersonalAccessTokenWhereInput | Filtering options for PersonalAccessTokens returned from the connection. |
|
secrets
HushConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[HushOrder!] | Ordering options for Hushes returned from the connection. | where
HushWhereInput | Filtering options for Hushes returned from the connection. |
|
orgMemberships
OrgMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrgMembershipOrder!] | Ordering options for OrgMemberships returned from the connection. | where
OrgMembershipWhereInput | Filtering options for OrgMemberships returned from the connection. |
|
groupMemberships
GroupMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupMembershipOrder!] | Ordering options for GroupMemberships returned from the connection. | where
GroupMembershipWhereInput | Filtering options for GroupMemberships returned from the connection. |
|
subscribers
SubscriberConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubscriberOrder!] | Ordering options for Subscribers returned from the connection. | where
SubscriberWhereInput | Filtering options for Subscribers returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
orgSubscriptions
OrgSubscriptionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
OrgSubscriptionOrder | Ordering options for OrgSubscriptions returned from the connection. | where
OrgSubscriptionWhereInput | Filtering options for OrgSubscriptions returned from the connection. |
|
EventBulkCreatePayload
Return response for createBulkEvent mutation
Fields
| Name | Description |
|---|
events
[Event!] | Created events |
EventBulkDeletePayload
Return response for deleteBulkEvent mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted event IDs |
EventBulkUpdatePayload
Return response for updateBulkEvent mutation
Fields
| Name | Description |
|---|
events
[Event!] | Updated events |
updatedIDs
[ID!] | IDs of the updated events |
EventConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EventEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EventCreatePayload
Return response for createEvent mutation
Fields
| Name | Description |
|---|
event
Event! | Created event |
EventDeletePayload
Return response for deleteEvent mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted event ID |
EventEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Event | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EventUpdatePayload
Return response for updateEvent mutation
Fields
| Name | Description |
|---|
event
Event! | Updated event |
Evidence
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
environmentName
String | the environment of the evidence |
environmentID
ID | the environment of the evidence |
scopeName
String | the scope of the evidence |
scopeID
ID | the scope of the evidence |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
name
String! | the name of the evidence |
description
String | the description of the evidence, what is contained in the uploaded file(s) or url(s) |
collectionProcedure
String | description of how the evidence was collected |
creationDate
Time! | the date the evidence was retrieved |
renewalDate
Time | the date the evidence should be renewed, defaults to a year from entry date |
source
String | the source of the evidence, e.g. system the evidence was retrieved from (splunk, github, etc) |
isAutomated
Boolean | whether the evidence was automatically generated |
url
String | the url of the evidence if not uploaded directly to the system |
status
EvidenceEvidenceStatus | the status of the evidence, ready, approved, needs renewal, missing artifact, rejected |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this evidence has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this evidence has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this evidence (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this evidence across all workflow instances Arguments |
EvidenceBulkCreatePayload
Return response for createBulkEvidence mutation
Fields
EvidenceBulkDeletePayload
Return response for deleteBulkEvidence mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted evidence IDs |
EvidenceBulkUpdatePayload
Return response for updateBulkEvidence mutation
Fields
| Name | Description |
|---|
evidences
[Evidence!] | Updated evidences |
updatedIDs
[ID!] | IDs of the updated evidence |
EvidenceConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[EvidenceEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
EvidenceCreatePayload
Return response for createEvidence mutation
Fields
| Name | Description |
|---|
evidence
Evidence! | Created evidence |
EvidenceDeletePayload
Return response for deleteEvidence mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted evidence ID |
EvidenceEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Evidence | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
EvidenceUpdatePayload
Return response for updateEvidence mutation
Fields
| Name | Description |
|---|
evidence
Evidence! | Updated evidence |
Export
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
requestorID
String | the user who initiated the request |
ownerID
ID | the organization id that owns the object |
exportType
ExportExportType! | the type of export, e.g., control, policy, etc. |
format
ExportExportFormat! | the format of export, e.g., csv and others |
status
ExportExportStatus! | the status of the export, e.g., pending, ready, failed |
fields
[String!] | the specific fields to include in the export (defaults to only the id if not provided) |
filters
String | the specific filters to run against the exported data. This should be a well formatted graphql query |
errorMessage
String | if we try to export and it fails, the error message will be stored here |
mode
ExportExportMode! | the mode of export, e.g., flat or folder |
exportMetadata
ExportMetadata | metadata for the export record |
owner
Organization | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
ExportBulkCreatePayload
Return response for createBulkExport mutation
Fields
| Name | Description |
|---|
exports
[Export!] | Created exports |
ExportBulkDeletePayload
Return response for deleteBulkExport mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted export IDs |
ExportConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ExportEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ExportCreatePayload
Return response for createExport mutation
Fields
| Name | Description |
|---|
export
Export! | Created export |
ExportDeletePayload
Return response for deleteExport mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted export ID |
ExportEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Export | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ExportUpdatePayload
Return response for updateExport mutation
Fields
| Name | Description |
|---|
export
Export! | Updated export |
File
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the file |
environmentID
ID | the environment of the file |
scopeName
String | the scope of the file |
scopeID
ID | the scope of the file |
providedFileName
String! | the name of the file provided in the payload key without the extension |
providedFileExtension
String! | the extension of the file provided |
providedFileSize
Int | the computed size of the file in the original http request |
persistedFileSize
Int | |
detectedMimeType
String | the mime type detected by the system |
md5Hash
String | the computed md5 hash of the file calculated after we received the contents of the file, but before the file was written to permanent storage |
detectedContentType
String! | the content type of the HTTP request - may be different than MIME type as multipart-form can transmit multiple files and different types |
storeKey
String | the key parsed out of a multipart-form request; if we allow multiple files to be uploaded we may want our API specifications to require the use of different keys allowing us to perform easier conditional evaluation on the key and what to do with the file based on key |
categoryType
String | the category type of the file, if any (e.g. evidence, invoice, etc.) |
uri
String | the full URI of the file |
storageScheme
String | the storage scheme of the file, e.g. file://, s3://, etc. |
storageVolume
String | the storage volume of the file which typically will be the organization ID the file belongs to - this is not a literal volume but the overlay file system mapping |
storagePath
String | the storage path is the second-level directory of the file path, typically the correlating logical object ID the file is associated with; files can be stand alone objects and not always correlated to a logical one, so this path of the tree may be empty |
metadata
Map | additional metadata about the file |
storageRegion
String | the region the file is stored in, if applicable |
storageProvider
String | the storage provider the file is stored in, if applicable |
lastAccessedAt
Time | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
organization
[Organization!] | |
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
contact
[Contact!] | |
entity
[Entity!] | |
organizationSetting
[OrganizationSetting!] | |
template
[Template!] | |
document
[DocumentData!] | |
program
[Program!] | |
platform
[Platform!] | |
evidence
[Evidence!] | |
identityHolder
[IdentityHolder!] | |
scan
[Scan!] | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
secrets
HushConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[HushOrder!] | Ordering options for Hushes returned from the connection. | where
HushWhereInput | Filtering options for Hushes returned from the connection. |
|
trustCenterEntities
TrustCenterEntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterEntityOrder!] | Ordering options for TrustCenterEntities returned from the connection. | where
TrustCenterEntityWhereInput | Filtering options for TrustCenterEntities returned from the connection. |
|
trustCenterDoc
[TrustCenterDoc!] | |
originalTrustCenterDoc
[TrustCenterDoc!] | |
presignedURL
String | |
base64
String | |
FileConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[FileEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
FileDeletePayload
Return response for deleteFile mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted file ID |
FileEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
File | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
Finding
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the finding |
environmentID
ID | the environment of the finding |
scopeName
String | the scope of the finding |
scopeID
ID | the scope of the finding |
externalID
String | external identifier from the integration source for the finding |
externalOwnerID
String | the owner of the finding |
source
String | system that produced the finding, e.g. gcpscc |
resourceName
String | resource identifier provided by the source system |
displayName
String | display name for the finding when provided by the source |
state
String | state reported by the source system, such as ACTIVE or INACTIVE |
category
String | primary category of the finding |
categories
[String!] | normalized categories for the finding |
findingClass
String | classification provided by the source, e.g. MISCONFIGURATION |
severity
String | severity label for the finding |
numericSeverity
Float | numeric severity score for the finding if provided |
score
Float | aggregated score such as CVSS for the finding |
impact
Float | impact score or rating for the finding |
exploitability
Float | exploitability score or rating for the finding |
priority
String | priority assigned to the finding |
open
Boolean | indicates if the finding is still open |
blocksProduction
Boolean | true when the finding blocks production changes |
production
Boolean | true when the finding affects production systems |
public
Boolean | true when the finding is publicly disclosed |
validated
Boolean | true when the finding has been validated by the security team |
assessmentID
String | identifier for the assessment that generated the finding |
description
String | long form description of the finding |
recommendation
String | short recommendation text from the source system (deprecated upstream) |
recommendedActions
String | markdown formatted remediation guidance for the finding |
references
[String!] | reference links for the finding |
stepsToReproduce
[String!] | steps required to reproduce the finding |
targets
[String!] | targets impacted by the finding such as projects or applications |
targetDetails
Map | structured details about the impacted targets |
vector
String | attack vector string such as a CVSS vector |
remediationSLA
Int | remediation service level agreement in days |
status
String | lifecycle status of the finding |
eventTime
DateTime | timestamp when the finding was last observed by the source |
reportedAt
DateTime | timestamp when the finding was first reported by the source |
sourceUpdatedAt
DateTime | timestamp when the source last updated the finding |
externalURI
String | link to the finding in the source system |
metadata
Map | raw metadata payload for the finding from the source system |
rawPayload
Map | raw payload received from the integration for auditing and troubleshooting |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
controlMappings
FindingControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingControlOrder!] | Ordering options for FindingControls returned from the connection. | where
FindingControlWhereInput | Filtering options for FindingControls returned from the connection. |
|
FindingBulkCreatePayload
Return response for createBulkFinding mutation
Fields
| Name | Description |
|---|
findings
[Finding!] | Created findings |
FindingBulkDeletePayload
Return response for deleteBulkFinding mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted finding IDs |
FindingBulkUpdatePayload
Return response for updateBulkFinding mutation
Fields
| Name | Description |
|---|
findings
[Finding!] | Updated findings |
updatedIDs
[ID!] | IDs of the updated findings |
FindingConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[FindingEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
FindingControl
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
findingID
ID! | the id of the finding associated with the control |
controlID
ID! | the id of the control mapped to the finding when it exists in the catalog |
standardID
ID | the id of the standard that the control belongs to when it exists in the catalog |
externalStandard
String | external identifier for the standard provided by the source system such as iso or hipaa |
externalStandardVersion
String | version for the external standard provided by the source system |
externalControlID
String | control identifier provided by the source system such as A.5.10 |
source
String | the integration source that provided the mapping |
metadata
Map | additional metadata about the control mapping from the source system |
discoveredAt
DateTime | timestamp when the mapping was first observed |
finding
Finding! | |
control
Control! | |
standard
Standard | |
FindingControlBulkCreatePayload
Return response for createBulkFindingControl mutation
Fields
FindingControlConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[FindingControlEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
FindingControlCreatePayload
Return response for createFindingControl mutation
Fields
FindingControlDeletePayload
Return response for deleteFindingControl mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted findingControl ID |
FindingControlEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
FindingControl | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
FindingControlUpdatePayload
Return response for updateFindingControl mutation
Fields
FindingCreatePayload
Return response for createFinding mutation
Fields
| Name | Description |
|---|
finding
Finding! | Created finding |
FindingDeletePayload
Return response for deleteFinding mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted finding ID |
FindingEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Finding | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
FindingUpdatePayload
Return response for updateFinding mutation
Fields
| Name | Description |
|---|
finding
Finding! | Updated finding |
Group
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
name
String! | the name of the group - must be unique within the organization |
description
String | the groups description |
isManaged
Boolean | whether the group is managed by the system |
gravatarLogoURL
String | the URL to an auto generated gravatar image for the group |
logoURL
String | the URL to an image uploaded by the customer for the groups avatar image |
avatarLocalFileID
ID | The group's local avatar file id, takes precedence over the gravatar logo URL |
displayName
String! | The group's displayed 'friendly' name |
oscalRole
String | OSCAL role identifier used for role-based responsibility mapping |
oscalPartyUUID
String | OSCAL party UUID linked to this group for responsibility mapping |
oscalContactUuids
[String!] | OSCAL contact UUID references associated with this group |
scimExternalID
String | the SCIM external ID for the group |
scimDisplayName
String | the SCIM displayname for the group |
scimActive
Boolean | whether the SCIM group is marked as active |
scimGroupMailing
String | the SCIM group mailing list email |
owner
Organization | |
programEditors
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
programBlockedGroups
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
programViewers
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
riskEditors
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
riskBlockedGroups
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
riskViewers
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
controlObjectiveEditors
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
controlObjectiveBlockedGroups
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
controlObjectiveViewers
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
narrativeEditors
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
narrativeBlockedGroups
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
narrativeViewers
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
controlImplementationEditors
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
controlImplementationBlockedGroups
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
controlImplementationViewers
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
scanEditors
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
scanBlockedGroups
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
scanViewers
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
entityEditors
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
entityBlockedGroups
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
entityViewers
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
actionPlanEditors
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
actionPlanBlockedGroups
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
actionPlanViewers
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
platformEditors
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
platformBlockedGroups
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
platformViewers
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
campaignEditors
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignBlockedGroups
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignViewers
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
procedureEditors
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
procedureBlockedGroups
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
internalPolicyEditors
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
internalPolicyBlockedGroups
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
controlEditors
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
controlBlockedGroups
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
mappedControlEditors
MappedControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[MappedControlOrder!] | Ordering options for MappedControls returned from the connection. | where
MappedControlWhereInput | Filtering options for MappedControls returned from the connection. |
|
mappedControlBlockedGroups
MappedControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[MappedControlOrder!] | Ordering options for MappedControls returned from the connection. | where
MappedControlWhereInput | Filtering options for MappedControls returned from the connection. |
|
setting
GroupSetting | |
users
UserConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[UserOrder!] | Ordering options for Users returned from the connection. | where
UserWhereInput | Filtering options for Users returned from the connection. |
|
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
avatarFile
File | |
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignTargets
CampaignTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignTargetOrder!] | Ordering options for CampaignTargets returned from the connection. | where
CampaignTargetWhereInput | Filtering options for CampaignTargets returned from the connection. |
|
members
GroupMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupMembershipOrder!] | Ordering options for GroupMemberships returned from the connection. | where
GroupMembershipWhereInput | Filtering options for GroupMemberships returned from the connection. |
|
permissions
GroupPermissionConnection! | permissions the group provides Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. |
|
GroupBulkCreatePayload
Return response for createBulkGroup mutation
Fields
| Name | Description |
|---|
groups
[Group!] | Created groups |
GroupBulkDeletePayload
Return response for deleteBulkGroup mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted group IDs |
GroupBulkUpdatePayload
Return response for updateBulkGroup mutation
Fields
| Name | Description |
|---|
groups
[Group!] | Updated groups |
updatedIDs
[ID!] | IDs of the updated groups |
GroupConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[GroupEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
GroupCreatePayload
Return response for createGroup mutation
Fields
| Name | Description |
|---|
group
Group! | Created group |
GroupDeletePayload
Return response for deleteGroup mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted group ID |
GroupEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Group | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
GroupMembership
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
role
GroupMembershipRole! | |
groupID
ID! | |
userID
ID! | |
group
Group! | |
user
User! | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
GroupMembershipBulkCreatePayload
Return response for createBulkGroupMembership mutation
Fields
GroupMembershipBulkDeletePayload
Return response for deleteBulkGroupMembership mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted groupMembership IDs |
GroupMembershipBulkUpdatePayload
Return response for updateBulkGroupMembership mutation
Fields
| Name | Description |
|---|
groupMemberships
[GroupMembership!] | Updated groupMemberships |
updatedIDs
[ID!] | IDs of the updated groupMemberships |
GroupMembershipConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[GroupMembershipEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
GroupMembershipCreatePayload
Return response for createGroupMembership mutation
Fields
GroupMembershipDeletePayload
Return response for deleteGroupMembership mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted groupMembership ID |
GroupMembershipEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
GroupMembership | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
GroupMembershipUpdatePayload
Return response for updateGroupMembership mutation
Fields
GroupPermission
GroupPermission contains details for the related object and the permissions
the group provides (or removes in the case of blocked) to the object within the
organization
Implements
Fields
| Name | Description |
|---|
objectType
String! | the type of object the permissions are for, e.g. Program, Control, etc. |
permissions
Permission! | the permissions the group has in relation to the object, e.g. EDITOR, VIEWER, BLOCKED |
id
ID! | the ID of the object the group was given permissions to |
displayID
String | the displayID of the object the group was given permissions to |
name
String | the name of the object the group was given permissions to |
GroupPermissionConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[GroupPermissionEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
GroupPermissionEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
GroupPermission | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
GroupSetting
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
visibility
GroupSettingVisibility! | whether the group is visible to it's members / owners only or if it's searchable by anyone within the organization |
joinPolicy
GroupSettingJoinPolicy! | the policy governing ability to freely join a group, whether it requires an invitation, application, or either |
syncToSlack
Boolean | whether to sync group members to slack groups |
syncToGithub
Boolean | whether to sync group members to github groups |
groupID
ID | the group id associated with the settings |
group
Group | |
GroupSettingBulkCreatePayload
Return response for createBulkGroupSetting mutation
Fields
GroupSettingBulkDeletePayload
Return response for deleteBulkGroupSetting mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted groupSetting IDs |
GroupSettingBulkUpdatePayload
Return response for updateBulkGroupSetting mutation
Fields
| Name | Description |
|---|
groupSettings
[GroupSetting!] | Updated groupSettings |
updatedIDs
[ID!] | IDs of the updated groupSettings |
GroupSettingConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[GroupSettingEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
GroupSettingCreatePayload
Return response for createGroupSetting mutation
Fields
GroupSettingDeletePayload
Return response for deleteGroupSetting mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted groupSetting ID |
GroupSettingEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
GroupSetting | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
GroupSettingUpdatePayload
Return response for updateGroupSetting mutation
Fields
GroupUpdatePayload
Return response for updateGroup mutation
Fields
| Name | Description |
|---|
group
Group! | Updated group |
Hush
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the logical name of the corresponding hush secret or it's general grouping |
description
String | a description of the hush value or purpose, such as github PAT |
kind
String | the kind of secret, such as sshkey, certificate, api token, etc. |
secretName
String | the generic name of a secret associated with the organization |
credentialSet
CredentialSet | a credential set, typically where you have multiple tokens or keys that compose one credential such as when accessing s3 and using access key ID, secret key, etc. |
metadata
Map | additional metadata about the credential |
lastUsedAt
Time | |
expiresAt
Time | when the token expires |
owner
Organization | |
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
HushBulkCreatePayload
Return response for createBulkHush mutation
Fields
| Name | Description |
|---|
hushes
[Hush!] | Created hushs |
HushBulkDeletePayload
Return response for deleteBulkHush mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted hush IDs |
HushBulkUpdatePayload
Return response for updateBulkHush mutation
Fields
| Name | Description |
|---|
hushes
[Hush!] | Updated hushs |
updatedIDs
[ID!] | IDs of the updated hushs |
HushConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[HushEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
HushCreatePayload
Return response for createHush mutation
Fields
| Name | Description |
|---|
hush
Hush! | Created hush |
HushDeletePayload
Return response for deleteHush mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted hush ID |
HushEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Hush | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
HushUpdatePayload
Return response for updateHush mutation
Fields
| Name | Description |
|---|
hush
Hush! | Updated hush |
IdentityHolder
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
internalOwner
String | the internal owner for the identity holder when no user or group is linked |
internalOwnerUserID
ID | the internal owner user id for the identity holder |
internalOwnerGroupID
ID | the internal owner group id for the identity holder |
environmentName
String | the environment of the identity_holder |
environmentID
ID | the environment of the identity_holder |
scopeName
String | the scope of the identity_holder |
scopeID
ID | the scope of the identity_holder |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
fullName
String! | the full name of the identity holder |
email
String! | the email address of the identity holder |
alternateEmail
String | alternate email address for the identity holder |
phoneNumber
String | phone number for the identity holder |
isOpenlaneUser
Boolean | whether the identity holder record is linked to an Openlane user account |
userID
ID | the user id associated with the identity holder record |
identityHolderType
IdentityHolderIdentityHolderType! | the classification of identity holders, such as employee or contractor |
status
IdentityHolderUserStatus! | the status of the identity holder record |
isActive
Boolean! | whether the identity holder record is active |
title
String | the job title of the identity holder |
department
String | the department or function of the identity holder |
team
String | the team name for the identity holder |
location
String | location or office for the identity holder |
startDate
DateTime | the start date for the identity holder |
endDate
DateTime | the end date for the identity holder, if applicable |
employerEntityID
ID | the external entity this identity holder is affiliated with |
externalUserID
String | external user identifier for the identity holder |
externalReferenceID
String | external identifier for the identity holder from an upstream roster |
metadata
Map | additional metadata about the identity holder |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalOwnerUser
User | |
internalOwnerGroup
Group | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
employer
Entity | |
assessmentResponses
AssessmentResponseConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentResponseOrder!] | Ordering options for AssessmentResponses returned from the connection. | where
AssessmentResponseWhereInput | Filtering options for AssessmentResponses returned from the connection. |
|
assessments
AssessmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentOrder!] | Ordering options for Assessments returned from the connection. | where
AssessmentWhereInput | Filtering options for Assessments returned from the connection. |
|
templates
TemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TemplateOrder!] | Ordering options for Templates returned from the connection. | where
TemplateWhereInput | Filtering options for Templates returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
accessPlatforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
user
User | |
hasPendingWorkflow
Boolean! | Indicates if this identityHolder has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this identityHolder has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this identityHolder (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this identityHolder across all workflow instances Arguments |
IdentityHolderBulkCreatePayload
Return response for createBulkIdentityHolder mutation
Fields
IdentityHolderBulkDeletePayload
Return response for deleteBulkIdentityHolder mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted identityHolder IDs |
IdentityHolderBulkUpdatePayload
Return response for updateBulkIdentityHolder mutation
Fields
| Name | Description |
|---|
identityHolders
[IdentityHolder!] | Updated identityHolders |
updatedIDs
[ID!] | IDs of the updated identityHolders |
IdentityHolderConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[IdentityHolderEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
IdentityHolderCreatePayload
Return response for createIdentityHolder mutation
Fields
IdentityHolderDeletePayload
Return response for deleteIdentityHolder mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted identityHolder ID |
IdentityHolderEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
IdentityHolder | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
IdentityHolderUpdatePayload
Return response for updateIdentityHolder mutation
Fields
Integration
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the integration |
environmentID
ID | the environment of the integration |
scopeName
String | the scope of the integration |
scopeID
ID | the scope of the integration |
name
String! | the name of the integration |
description
String | a description of the integration |
kind
String | the kind of integration, such as github, slack, s3 etc. |
integrationType
String | the type of integration, such as communicattion, storage, SCM, etc. |
platformID
ID | optional platform associated with this integration for downstream inventory linkage |
metadata
Map | additional metadata about the integration |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
secrets
HushConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[HushOrder!] | Ordering options for Hushes returned from the connection. | where
HushWhereInput | Filtering options for Hushes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
directoryGroups
DirectoryGroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryGroupOrder!] | Ordering options for DirectoryGroups returned from the connection. | where
DirectoryGroupWhereInput | Filtering options for DirectoryGroups returned from the connection. |
|
directoryMemberships
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
directorySyncRuns
DirectorySyncRunConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectorySyncRunOrder!] | Ordering options for DirectorySyncRuns returned from the connection. | where
DirectorySyncRunWhereInput | Filtering options for DirectorySyncRuns returned from the connection. |
|
platform
Platform | platform associated with this integration |
notificationTemplates
NotificationTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NotificationTemplateOrder!] | Ordering options for NotificationTemplates returned from the connection. | where
NotificationTemplateWhereInput | Filtering options for NotificationTemplates returned from the connection. |
|
emailTemplates
EmailTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailTemplateOrder!] | Ordering options for EmailTemplates returned from the connection. | where
EmailTemplateWhereInput | Filtering options for EmailTemplates returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
IntegrationConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[IntegrationEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
IntegrationDeletePayload
Return response for deleteIntegration mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted integration ID |
IntegrationEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Integration | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
InternalPolicy
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
revision
String | revision of the object as a semver (e.g. v1.0.0), by default any update will bump the patch version, unless the revision_bump field is set |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the name of the policy |
status
InternalPolicyDocumentStatus | status of the policy, e.g. draft, published, archived, etc. |
details
String | details of the policy |
detailsJSON
[Any!] | structured details of the policy in JSON format |
approvalRequired
Boolean | whether approval is required for edits to the policy |
reviewDue
Time | the date the policy should be reviewed, calculated based on the review_frequency if not directly set |
reviewFrequency
InternalPolicyFrequency | the frequency at which the policy should be reviewed, used to calculate the review_due date |
approverID
ID | the id of the group responsible for approving the policy |
delegateID
ID | the id of the group responsible for approving the policy |
summary
String | |
tagSuggestions
[String!] | auto-generated tag suggestions for the policy |
dismissedTagSuggestions
[String!] | tag suggestions dismissed by the user for the policy |
controlSuggestions
[String!] | proposed controls referenced in the policy |
dismissedControlSuggestions
[String!] | control suggestions dismissed by the user for the policy |
improvementSuggestions
[String!] | suggested improvements for the policy |
dismissedImprovementSuggestions
[String!] | improvement suggestions dismissed by the user for the policy |
url
String | This will contain the url used to create or update the policy |
fileID
ID | This will contain the most recent file id if this policy was created from a file |
internalPolicyKindName
String | the kind of the internal_policy |
internalPolicyKindID
ID | the kind of the internal_policy |
environmentName
String | the environment of the internal_policy |
environmentID
ID | the environment of the internal_policy |
scopeName
String | the scope of the internal_policy |
scopeID
ID | the scope of the internal_policy |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
approver
Group | the group of users who are responsible for approving the policy |
delegate
Group | temporary delegates for the policy, used for temporary approval |
internalPolicyKind
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
file
File | |
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this internalPolicy has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this internalPolicy has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this internalPolicy (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this internalPolicy across all workflow instances Arguments |
InternalPolicyBulkCreatePayload
Return response for createBulkInternalPolicy mutation
Fields
InternalPolicyBulkDeletePayload
Return response for deleteBulkInternalPolicy mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted internalPolicy IDs |
InternalPolicyBulkUpdatePayload
Return response for updateBulkInternalPolicy mutation
Fields
| Name | Description |
|---|
internalPolicies
[InternalPolicy!] | Updated internalPolicys |
updatedIDs
[ID!] | IDs of the updated internalPolicys |
InternalPolicyConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[InternalPolicyEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
InternalPolicyCreatePayload
Return response for createInternalPolicy mutation
Fields
InternalPolicyDeletePayload
Return response for deleteInternalPolicy mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted internalPolicy ID |
InternalPolicyEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
InternalPolicy | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
InternalPolicyUpdatePayload
Return response for updateInternalPolicy mutation
Fields
Invite
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
requestorID
String | the user who initiated the request |
ownerID
ID | the organization id that owns the object |
expires
Time | the expiration date of the invitation token which defaults to 14 days in the future from creation |
recipient
String! | the email used as input to generate the invitation token and is the destination person the invitation is sent to who is required to accept to join the organization |
status
InviteInviteStatus! | the status of the invitation |
role
InviteRole! | |
sendAttempts
Int! | the number of attempts made to perform email send of the invitation, maximum of 5 |
ownershipTransfer
Boolean | indicates if this invitation is for transferring organization ownership - when accepted, current owner becomes admin and invitee becomes owner |
owner
Organization | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
InviteBulkCreatePayload
Return response for createBulkInvite mutation
Fields
| Name | Description |
|---|
invites
[Invite!] | Created invites |
InviteBulkDeletePayload
Return response for deleteBulkInvite mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted invite IDs |
InviteBulkUpdatePayload
Return response for updateBulkInvite mutation
Fields
| Name | Description |
|---|
invites
[Invite!] | Updated invites |
updatedIDs
[ID!] | IDs of the updated invites |
InviteConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[InviteEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
InviteCreatePayload
Return response for createInvite mutation
Fields
| Name | Description |
|---|
invite
Invite! | Created invite |
InviteDeletePayload
Return response for deleteInvite mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted invite ID |
InviteEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Invite | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
InviteUpdatePayload
Return response for updateInvite mutation
Fields
| Name | Description |
|---|
invite
Invite! | Updated invite |
JobResult
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
scheduledJobID
ID! | the job this result belongs to |
status
JobResultJobExecutionStatus! | the status of this job. did it fail? did it succeed? |
exitCode
Int! | the exit code from the script that was executed |
finishedAt
Time! | The time the job finished it's execution. This is different from the db insertion time |
startedAt
Time! | The time the job started it's execution. This is different from the db insertion time |
fileID
ID! | |
log
String | the log output from the job |
owner
Organization | |
scheduledJob
ScheduledJob! | |
file
File! | |
JobResultConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[JobResultEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
JobResultCreatePayload
Return response for createJobResult mutation
Fields
| Name | Description |
|---|
jobResult
JobResult! | Created jobResult |
JobResultDeletePayload
Return response for deleteJobResult mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted jobResult ID |
JobResultEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
JobResult | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
JobResultUpdatePayload
Return response for updateJobResult mutation
Fields
| Name | Description |
|---|
jobResult
JobResult! | Updated jobResult |
JobRunner
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the name of the runner |
status
JobRunnerJobRunnerStatus! | the status of this runner |
ipAddress
String | the IP address of this runner |
lastSeen
Time | the last time this runner was seen |
version
String | the version of the runner |
os
String | the operating system of the runner |
owner
Organization | |
jobRunnerTokens
JobRunnerTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobRunnerTokenOrder!] | Ordering options for JobRunnerTokens returned from the connection. | where
JobRunnerTokenWhereInput | Filtering options for JobRunnerTokens returned from the connection. |
|
JobRunnerConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[JobRunnerEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
JobRunnerCreatePayload
Return response for createJobRunner mutation
Fields
| Name | Description |
|---|
jobRunner
JobRunner! | Created jobRunner |
JobRunnerDeletePayload
Return response for deleteJobRunner mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted jobRunner ID |
JobRunnerEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
JobRunner | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
JobRunnerRegistrationToken
Implements
Fields
JobRunnerRegistrationTokenBulkCreatePayload
Return response for createBulkJobRunnerRegistrationToken mutation
Fields
JobRunnerRegistrationTokenConnection
A connection to a list of items.
Fields
JobRunnerRegistrationTokenCreatePayload
Return response for createJobRunnerRegistrationToken mutation
Fields
JobRunnerRegistrationTokenDeletePayload
Return response for deleteJobRunnerRegistrationToken mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted jobRunnerRegistrationToken ID |
JobRunnerRegistrationTokenEdge
An edge in a connection.
Fields
JobRunnerToken
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
token
String! | |
expiresAt
Time | when the token expires |
lastUsedAt
Time | |
isActive
Boolean | whether the token is active |
revokedReason
String | the reason the token was revoked |
revokedBy
String | the user who revoked the token |
revokedAt
Time | when the token was revoked |
owner
Organization | |
jobRunners
JobRunnerConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobRunnerOrder!] | Ordering options for JobRunners returned from the connection. | where
JobRunnerWhereInput | Filtering options for JobRunners returned from the connection. |
|
JobRunnerTokenConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[JobRunnerTokenEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
JobRunnerTokenCreatePayload
Return response for createJobRunnerToken mutation
Fields
JobRunnerTokenDeletePayload
Return response for deleteJobRunnerToken mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted jobRunnerToken ID |
JobRunnerTokenEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
JobRunnerToken | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
JobRunnerTokenUpdatePayload
Return response for updateJobRunnerToken mutation
Fields
JobRunnerUpdatePayload
Return response for updateJobRunner mutation
Fields
| Name | Description |
|---|
jobRunner
JobRunner! | Updated jobRunner |
JobTemplate
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
title
String! | the title of the job |
description
String | the short description of the job and what it does |
platform
JobTemplateJobPlatformType! | the platform to use to execute this job, e.g. golang, typescript, python, etc. |
downloadURL
String! | the url from where to download the script from |
configuration
JobConfiguration | the json configuration to run this job, which could be used to template a job, e.g. { "account_name": "my-account" } |
cron
String | cron schedule to run the job in cron 6-field syntax, e.g. 0 0 0 * * * |
owner
Organization | |
scheduledJobs
ScheduledJobConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScheduledJobOrder!] | Ordering options for ScheduledJobs returned from the connection. | where
ScheduledJobWhereInput | Filtering options for ScheduledJobs returned from the connection. |
|
JobTemplateBulkCreatePayload
Return response for createBulkJobTemplate mutation
Fields
JobTemplateBulkDeletePayload
Return response for deleteBulkJobTemplate mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted jobTemplate IDs |
JobTemplateBulkUpdatePayload
Return response for updateBulkJobTemplate mutation
Fields
| Name | Description |
|---|
jobTemplates
[JobTemplate!] | Updated jobTemplates |
updatedIDs
[ID!] | IDs of the updated jobTemplates |
JobTemplateConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[JobTemplateEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
JobTemplateCreatePayload
Return response for createJobTemplate mutation
Fields
JobTemplateDeletePayload
Return response for deleteJobTemplate mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted jobTemplate ID |
JobTemplateEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
JobTemplate | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
JobTemplateUpdatePayload
Return response for updateJobTemplate mutation
Fields
MappableDomain
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
name
String! | Name of the mappable domain |
zoneID
String! | DNS Zone ID of the mappable domain. |
customDomains
CustomDomainConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CustomDomainOrder!] | Ordering options for CustomDomains returned from the connection. | where
CustomDomainWhereInput | Filtering options for CustomDomains returned from the connection. |
|
MappableDomainBulkCreatePayload
Return response for createBulkMappableDomain mutation
Fields
MappableDomainBulkDeletePayload
Return response for deleteBulkMappableDomain mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted mappableDomain IDs |
MappableDomainBulkUpdatePayload
Return response for updateBulkMappableDomain mutation
Fields
| Name | Description |
|---|
mappableDomains
[MappableDomain!] | Updated mappableDomains |
updatedIDs
[ID!] | IDs of the updated mappableDomains |
MappableDomainConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[MappableDomainEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
MappableDomainCreatePayload
Return response for createMappableDomain mutation
Fields
MappableDomainDeletePayload
Return response for deleteMappableDomain mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted mappableDomain ID |
MappableDomainEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
MappableDomain | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
MappableDomainUpdatePayload
Return response for updateMappableDomain mutation
Fields
MappedControl
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
ownerID
ID | the organization id that owns the object |
mappingType
MappedControlMappingType! | the type of mapping between the two controls, e.g. subset, intersect, equal, superset |
relation
String | description of how the two controls are related |
confidence
Int | percentage (0-100) of confidence in the mapping |
source
MappedControlMappingSource | source of the mapping, e.g. manual, suggested, etc. |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
fromControls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
toControls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
fromSubcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
toSubcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
MappedControlBulkCreatePayload
Return response for createBulkMappedControl mutation
Fields
MappedControlBulkDeletePayload
Return response for deleteBulkMappedControl mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted mappedControl IDs |
MappedControlBulkUpdatePayload
Return response for updateBulkMappedControl mutation
Fields
| Name | Description |
|---|
mappedControls
[MappedControl!] | Updated mappedControls |
updatedIDs
[ID!] | IDs of the updated mappedControls |
MappedControlConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[MappedControlEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
MappedControlCreatePayload
Return response for createMappedControl mutation
Fields
MappedControlDeletePayload
Return response for deleteMappedControl mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted mappedControl ID |
MappedControlEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
MappedControl | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
MappedControlUpdatePayload
Return response for updateMappedControl mutation
Fields
Narrative
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the name of the narrative |
description
String | the description of the narrative |
details
String | text data for the narrative document |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
satisfies
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
NarrativeBulkCreatePayload
Return response for createBulkNarrative mutation
Fields
NarrativeBulkDeletePayload
Return response for deleteBulkNarrative mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted narrative IDs |
NarrativeBulkUpdatePayload
Return response for updateBulkNarrative mutation
Fields
| Name | Description |
|---|
narratives
[Narrative!] | Updated narratives |
updatedIDs
[ID!] | IDs of the updated narratives |
NarrativeConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[NarrativeEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
NarrativeCreatePayload
Return response for createNarrative mutation
Fields
| Name | Description |
|---|
narrative
Narrative! | Created narrative |
NarrativeDeletePayload
Return response for deleteNarrative mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted narrative ID |
NarrativeEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Narrative | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
NarrativeUpdatePayload
Return response for updateNarrative mutation
Fields
| Name | Description |
|---|
narrative
Narrative! | Updated narrative |
Note
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
ownerID
ID | the ID of the organization owner of the object |
title
String | the title of the note |
text
String! | the text of the note |
textJSON
[Any!] | structured details of the note in JSON format |
noteRef
String | ref location of the note |
discussionID
ID | the external discussion id this note is associated with |
isEdited
Boolean! | whether the note has been edited |
trustCenterID
ID | the trust center this note belongs to, if applicable |
owner
Organization | |
task
Task | |
control
Control | |
subcontrol
Subcontrol | |
procedure
Procedure | |
risk
Risk | |
internalPolicy
InternalPolicy | |
evidence
Evidence | |
trustCenter
TrustCenter | |
discussion
Discussion | |
trustCenterFaqs
TrustCenterFAQConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterFAQOrder!] | Ordering options for TrustCenterFAQs returned from the connection. | where
TrustCenterFAQWhereInput | Filtering options for TrustCenterFAQs returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
NoteConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[NoteEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
NoteDeletePayload
Return response for deleteComment mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted comment ID |
NoteEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Note | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
Notification
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
userID
ID | the user this notification is for |
notificationType
NotificationNotificationType! | the type of notification - organization or user |
objectType
String! | the event type this notification is related to (e.g., task.created, control.updated) |
title
String! | the title of the notification |
body
String! | the body text of the notification |
data
Map | structured payload containing IDs, links, and other notification data |
templateID
ID | optional template used for external channel rendering |
readAt
DateTime | the time the notification was read |
channels
[Channel!] | the channels this notification should be sent to (IN_APP, SLACK, EMAIL) |
topic
NotificationNotificationTopic | the topic of the notification (TASK_ASSIGNMENT, APPROVAL, MENTION, EXPORT) |
owner
Organization | |
notificationTemplate
NotificationTemplate | |
NotificationConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[NotificationEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
NotificationEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Notification | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
NotificationPreference
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
userID
ID! | the user this preference applies to |
channel
NotificationPreferenceChannel! | the channel this preference applies to |
status
NotificationPreferenceNotificationChannelStatus! | status of the channel configuration |
provider
String | provider service for the channel, e.g. sendgrid, mailgun for email or workspace name for slack |
destination
String | destination address or endpoint for the channel |
config
Map | channel configuration payload |
enabled
Boolean! | whether this preference is enabled |
cadence
NotificationPreferenceNotificationCadence! | delivery cadence for this preference |
priority
NotificationPreferencePriority | optional priority override for this preference |
topicPatterns
[String!] | topic names or wildcard patterns this preference applies to; empty means all |
topicOverrides
Map | optional per-topic overrides (e.g. template_id, cadence, priority) keyed by topic name |
templateID
ID | optional template to use by default for this preference (external channels only) |
muteUntil
Time | mute notifications until this time |
quietHoursStart
String | start of quiet hours in HH:MM |
quietHoursEnd
String | end of quiet hours in HH:MM |
timezone
String | timezone for quiet hours and digests |
isDefault
Boolean! | whether this is the default config for the channel |
verifiedAt
Time | when the channel config was verified |
lastUsedAt
Time | last time the channel config was used |
lastError
String | last error encountered while using the channel |
metadata
Map | additional preference metadata |
owner
Organization | |
user
User! | |
notificationTemplate
NotificationTemplate | |
NotificationPreferenceBulkCreatePayload
Return response for createBulkNotificationPreference mutation
Fields
NotificationPreferenceBulkDeletePayload
Return response for deleteBulkNotificationPreference mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted notificationPreference IDs |
NotificationPreferenceBulkUpdatePayload
Return response for updateBulkNotificationPreference mutation
Fields
| Name | Description |
|---|
notificationPreferences
[NotificationPreference!] | Updated notificationPreferences |
updatedIDs
[ID!] | IDs of the updated notificationPreferences |
NotificationPreferenceConnection
A connection to a list of items.
Fields
NotificationPreferenceCreatePayload
Return response for createNotificationPreference mutation
Fields
NotificationPreferenceDeletePayload
Return response for deleteNotificationPreference mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted notificationPreference ID |
NotificationPreferenceEdge
An edge in a connection.
Fields
NotificationPreferenceUpdatePayload
Return response for updateNotificationPreference mutation
Fields
NotificationTemplate
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
key
String! | stable identifier for the template |
name
String! | display name for the template |
description
String | description of the template |
channel
NotificationTemplateChannel! | channel this template is intended for |
format
NotificationTemplateNotificationTemplateFormat! | template format for rendering |
locale
String! | locale for the template, e.g. en-US |
topicPattern
String! | topic name or wildcard pattern this template targets |
integrationID
ID | integration associated with this template |
workflowDefinitionID
ID | workflow definition associated with this template |
emailTemplateID
ID | optional email template used for branded email delivery |
titleTemplate
String | title template for external channel messages |
subjectTemplate
String | subject template for email notifications |
bodyTemplate
String | body template for the notification |
blocks
Map | structured blocks for channels like Slack or Teams |
jsonconfig
Map | jsonschema for template data requirements |
uischema
Map | uischema for a template builder |
metadata
Map | additional template metadata |
active
Boolean! | whether the template is active |
version
Int! | template version |
owner
Organization | |
integration
Integration | |
workflowDefinition
WorkflowDefinition | |
emailTemplate
EmailTemplate | |
notifications
NotificationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
NotificationOrder | Ordering options for Notifications returned from the connection. |
|
NotificationTemplateBulkCreatePayload
Return response for createBulkNotificationTemplate mutation
Fields
NotificationTemplateBulkDeletePayload
Return response for deleteBulkNotificationTemplate mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted notificationTemplate IDs |
NotificationTemplateBulkUpdatePayload
Return response for updateBulkNotificationTemplate mutation
Fields
| Name | Description |
|---|
notificationTemplates
[NotificationTemplate!] | Updated notificationTemplates |
updatedIDs
[ID!] | IDs of the updated notificationTemplates |
NotificationTemplateConnection
A connection to a list of items.
Fields
NotificationTemplateCreatePayload
Return response for createNotificationTemplate mutation
Fields
NotificationTemplateDeletePayload
Return response for deleteNotificationTemplate mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted notificationTemplate ID |
NotificationTemplateEdge
An edge in a connection.
Fields
NotificationTemplateUpdatePayload
Return response for updateNotificationTemplate mutation
Fields
NotificationUpdatePayload
Return response for updateNotification mutation
Fields
Onboarding
Implements
Fields
| Name | Description |
|---|
id
ID! | |
organizationID
ID | |
companyName
String! | name of the company |
domains
[String!] | domains associated with the company |
companyDetails
Map | details given about the company during the onboarding process, including things such as company size, sector, etc |
userDetails
Map | details given about the user during the onboarding process, including things such as name, job title, department, etc |
compliance
Map | details given about the compliance requirements during the onboarding process, such as coming with existing policies, controls, risk assessments, etc |
demoRequested
Boolean | |
organization
Organization | |
OnboardingCreatePayload
Return response for createOnboarding mutation
Fields
| Name | Description |
|---|
onboarding
Onboarding! | Created onboarding |
Organization
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
name
String! | the name of the organization |
displayName
String! | The organization's displayed 'friendly' name |
description
String | An optional description of the organization |
personalOrg
Boolean | orgs directly associated with a user |
avatarRemoteURL
String | URL of the user's remote avatar |
avatarLocalFileID
ID | The organizations's local avatar file id, takes precedence over the avatar remote URL |
avatarUpdatedAt
Time | The time the user's (local) avatar was last updated |
dedicatedDb
Boolean! | Whether the organization has a dedicated database |
stripeCustomerID
String | the stripe customer ID this organization is associated to |
controlCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
controlImplementationCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
controlObjectiveCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
evidenceCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
assetCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
findingCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
vulnerabilityCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
groupCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalPolicyCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
mappedControlCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
narrativeCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
procedureCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
programCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
riskCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
identityHolderCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
scheduledJobCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
standardCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
templateCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
subprocessorCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenterDocCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenterSubprocessorCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
actionPlanCreators
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
parent
Organization | |
children
OrganizationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrganizationOrder!] | Ordering options for Organizations returned from the connection. | where
OrganizationWhereInput | Filtering options for Organizations returned from the connection. |
|
setting
OrganizationSetting | |
personalAccessTokens
PersonalAccessTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PersonalAccessTokenOrder!] | Ordering options for PersonalAccessTokens returned from the connection. | where
PersonalAccessTokenWhereInput | Filtering options for PersonalAccessTokens returned from the connection. |
|
apiTokens
APITokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[APITokenOrder!] | Ordering options for APITokens returned from the connection. | where
APITokenWhereInput | Filtering options for APITokens returned from the connection. |
|
emailBrandings
EmailBrandingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailBrandingOrder!] | Ordering options for EmailBrandings returned from the connection. | where
EmailBrandingWhereInput | Filtering options for EmailBrandings returned from the connection. |
|
emailTemplates
EmailTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailTemplateOrder!] | Ordering options for EmailTemplates returned from the connection. | where
EmailTemplateWhereInput | Filtering options for EmailTemplates returned from the connection. |
|
notificationPreferences
NotificationPreferenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NotificationPreferenceOrder!] | Ordering options for NotificationPreferences returned from the connection. | where
NotificationPreferenceWhereInput | Filtering options for NotificationPreferences returned from the connection. |
|
notificationTemplates
NotificationTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NotificationTemplateOrder!] | Ordering options for NotificationTemplates returned from the connection. | where
NotificationTemplateWhereInput | Filtering options for NotificationTemplates returned from the connection. |
|
users
UserConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[UserOrder!] | Ordering options for Users returned from the connection. | where
UserWhereInput | Filtering options for Users returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
secrets
HushConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[HushOrder!] | Ordering options for Hushes returned from the connection. | where
HushWhereInput | Filtering options for Hushes returned from the connection. |
|
avatarFile
File | |
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
templates
TemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TemplateOrder!] | Ordering options for Templates returned from the connection. | where
TemplateWhereInput | Filtering options for Templates returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
documents
DocumentDataConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DocumentDataOrder!] | Ordering options for DocumentDataSlice returned from the connection. | where
DocumentDataWhereInput | Filtering options for DocumentDataSlice returned from the connection. |
|
orgSubscriptions
[OrgSubscription!] | |
invites
InviteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InviteOrder!] | Ordering options for Invites returned from the connection. | where
InviteWhereInput | Filtering options for Invites returned from the connection. |
|
subscribers
SubscriberConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubscriberOrder!] | Ordering options for Subscribers returned from the connection. | where
SubscriberWhereInput | Filtering options for Subscribers returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignTargets
CampaignTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignTargetOrder!] | Ordering options for CampaignTargets returned from the connection. | where
CampaignTargetWhereInput | Filtering options for CampaignTargets returned from the connection. |
|
entityTypes
EntityTypeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityTypeOrder!] | Ordering options for EntityTypes returned from the connection. | where
EntityTypeWhereInput | Filtering options for EntityTypes returned from the connection. |
|
contacts
ContactConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ContactOrder!] | Ordering options for Contacts returned from the connection. | where
ContactWhereInput | Filtering options for Contacts returned from the connection. |
|
notes
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
systemDetails
SystemDetailConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SystemDetailOrder!] | Ordering options for SystemDetails returned from the connection. | where
SystemDetailWhereInput | Filtering options for SystemDetails returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
mappedControls
MappedControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[MappedControlOrder!] | Ordering options for MappedControls returned from the connection. | where
MappedControlWhereInput | Filtering options for MappedControls returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
standards
StandardConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[StandardOrder!] | Ordering options for Standards returned from the connection. | where
StandardWhereInput | Filtering options for Standards returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
customDomains
CustomDomainConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CustomDomainOrder!] | Ordering options for CustomDomains returned from the connection. | where
CustomDomainWhereInput | Filtering options for CustomDomains returned from the connection. |
|
jobRunners
JobRunnerConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobRunnerOrder!] | Ordering options for JobRunners returned from the connection. | where
JobRunnerWhereInput | Filtering options for JobRunners returned from the connection. |
|
jobRunnerTokens
JobRunnerTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobRunnerTokenOrder!] | Ordering options for JobRunnerTokens returned from the connection. | where
JobRunnerTokenWhereInput | Filtering options for JobRunnerTokens returned from the connection. |
|
jobRunnerRegistrationTokens
JobRunnerRegistrationTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobRunnerRegistrationTokenOrder!] | Ordering options for JobRunnerRegistrationTokens returned from the connection. | where
JobRunnerRegistrationTokenWhereInput | Filtering options for JobRunnerRegistrationTokens returned from the connection. |
|
dnsVerifications
DNSVerificationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DNSVerificationOrder!] | Ordering options for DNSVerifications returned from the connection. | where
DNSVerificationWhereInput | Filtering options for DNSVerifications returned from the connection. |
|
jobTemplates
JobTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobTemplateOrder!] | Ordering options for JobTemplates returned from the connection. | where
JobTemplateWhereInput | Filtering options for JobTemplates returned from the connection. |
|
scheduledJobs
ScheduledJobConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScheduledJobOrder!] | Ordering options for ScheduledJobs returned from the connection. | where
ScheduledJobWhereInput | Filtering options for ScheduledJobs returned from the connection. |
|
jobResults
JobResultConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[JobResultOrder!] | Ordering options for JobResults returned from the connection. | where
JobResultWhereInput | Filtering options for JobResults returned from the connection. |
|
scheduledJobRuns
ScheduledJobRunConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScheduledJobRunOrder!] | Ordering options for ScheduledJobRuns returned from the connection. | where
ScheduledJobRunWhereInput | Filtering options for ScheduledJobRuns returned from the connection. |
|
trustCenters
TrustCenterConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterOrder!] | Ordering options for TrustCenters returned from the connection. | where
TrustCenterWhereInput | Filtering options for TrustCenters returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
subprocessors
SubprocessorConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubprocessorOrder!] | Ordering options for Subprocessors returned from the connection. | where
SubprocessorWhereInput | Filtering options for Subprocessors returned from the connection. |
|
exports
ExportConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ExportOrder!] | Ordering options for Exports returned from the connection. | where
ExportWhereInput | Filtering options for Exports returned from the connection. |
|
trustCenterWatermarkConfigs
TrustCenterWatermarkConfigConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterWatermarkConfigOrder!] | Ordering options for TrustCenterWatermarkConfigs returned from the connection. | where
TrustCenterWatermarkConfigWhereInput | Filtering options for TrustCenterWatermarkConfigs returned from the connection. |
|
assessments
AssessmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentOrder!] | Ordering options for Assessments returned from the connection. | where
AssessmentWhereInput | Filtering options for Assessments returned from the connection. |
|
assessmentResponses
AssessmentResponseConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentResponseOrder!] | Ordering options for AssessmentResponses returned from the connection. | where
AssessmentResponseWhereInput | Filtering options for AssessmentResponses returned from the connection. |
|
customTypeEnums
CustomTypeEnumConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CustomTypeEnumOrder!] | Ordering options for CustomTypeEnums returned from the connection. | where
CustomTypeEnumWhereInput | Filtering options for CustomTypeEnums returned from the connection. |
|
tagDefinitions
TagDefinitionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TagDefinitionOrder!] | Ordering options for TagDefinitions returned from the connection. | where
TagDefinitionWhereInput | Filtering options for TagDefinitions returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
workflowDefinitions
WorkflowDefinitionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowDefinitionOrder!] | Ordering options for WorkflowDefinitions returned from the connection. | where
WorkflowDefinitionWhereInput | Filtering options for WorkflowDefinitions returned from the connection. |
|
workflowInstances
WorkflowInstanceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowInstanceOrder!] | Ordering options for WorkflowInstances returned from the connection. | where
WorkflowInstanceWhereInput | Filtering options for WorkflowInstances returned from the connection. |
|
workflowEvents
WorkflowEventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowEventOrder!] | Ordering options for WorkflowEvents returned from the connection. | where
WorkflowEventWhereInput | Filtering options for WorkflowEvents returned from the connection. |
|
workflowAssignments
WorkflowAssignmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowAssignmentOrder!] | Ordering options for WorkflowAssignments returned from the connection. | where
WorkflowAssignmentWhereInput | Filtering options for WorkflowAssignments returned from the connection. |
|
workflowAssignmentTargets
WorkflowAssignmentTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowAssignmentTargetOrder!] | Ordering options for WorkflowAssignmentTargets returned from the connection. | where
WorkflowAssignmentTargetWhereInput | Filtering options for WorkflowAssignmentTargets returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
directoryGroups
DirectoryGroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryGroupOrder!] | Ordering options for DirectoryGroups returned from the connection. | where
DirectoryGroupWhereInput | Filtering options for DirectoryGroups returned from the connection. |
|
directoryMemberships
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
directorySyncRuns
DirectorySyncRunConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectorySyncRunOrder!] | Ordering options for DirectorySyncRuns returned from the connection. | where
DirectorySyncRunWhereInput | Filtering options for DirectorySyncRuns returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
members
OrgMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrgMembershipOrder!] | Ordering options for OrgMemberships returned from the connection. | where
OrgMembershipWhereInput | Filtering options for OrgMemberships returned from the connection. |
|
OrganizationBulkCreatePayload
Return response for createBulkOrganization mutation
Fields
OrganizationConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[OrganizationEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
OrganizationCreatePayload
Return response for createOrganization mutation
Fields
OrganizationDeletePayload
Return response for deleteOrganization mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted organization ID |
OrganizationEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Organization | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
OrganizationSetting
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
domains
[String!] | domains associated with the organization |
billingContact
String | Name of the person to contact for billing |
billingEmail
String | Email address of the person to contact for billing |
billingPhone
String | Phone number to contact for billing |
billingAddress
Address | the billing address to send billing information to |
taxIdentifier
String | Usually government-issued tax ID or business ID such as ABN in Australia |
geoLocation
OrganizationSettingRegion | geographical location of the organization |
organizationID
ID | the ID of the organization the settings belong to |
billingNotificationsEnabled
Boolean! | should we send email notifications related to billing |
allowedEmailDomains
[String!] | domains allowed to access the organization, if empty all domains are allowed |
allowMatchingDomainsAutojoin
Boolean | allow users who can successfully confirm their email or who login via social providers with an email that matches the organizations configured allowed domain to auto-join the organization |
identityProvider
OrganizationSettingSSOProvider | SSO provider type for the organization |
identityProviderClientID
String | client ID for SSO integration |
identityProviderClientSecret
String | client secret for SSO integration |
identityProviderMetadataEndpoint
String | metadata URL for the SSO provider |
identityProviderAuthTested
Boolean! | has this sso configuration been tested to verify it works? SSO cannot be enforced unless this is done |
identityProviderEntityID
String | SAML entity ID for the SSO provider |
oidcDiscoveryEndpoint
String | OIDC discovery URL for the SSO provider |
samlSigninURL
String | the sign in URL to be used for SAML-based authentication |
samlIssuer
String | the SAML issuer |
samlCert
String | the x509 certificate used to validate SAML responses |
identityProviderLoginEnforced
Boolean! | enforce SSO authentication for organization members |
multifactorAuthEnforced
Boolean | enforce 2fa / multifactor authentication for organization members |
complianceWebhookToken
String | unique token used to receive compliance webhook events |
paymentMethodAdded
Boolean! | whether or not a payment method has been added to the account |
organization
Organization | |
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
OrganizationSettingBulkCreatePayload
Return response for createBulkOrganizationSetting mutation
Fields
OrganizationSettingBulkDeletePayload
Return response for deleteBulkOrganizationSetting mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted organizationSetting IDs |
OrganizationSettingBulkUpdatePayload
Return response for updateBulkOrganizationSetting mutation
Fields
| Name | Description |
|---|
organizationSettings
[OrganizationSetting!] | Updated organizationSettings |
updatedIDs
[ID!] | IDs of the updated organizationSettings |
OrganizationSettingConnection
A connection to a list of items.
Fields
OrganizationSettingCreatePayload
Return response for createOrganizationSetting mutation
Fields
OrganizationSettingDeletePayload
Return response for deleteOrganizationSetting mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted organizationSetting ID |
OrganizationSettingEdge
An edge in a connection.
Fields
OrganizationSettingUpdatePayload
Return response for updateOrganizationSetting mutation
Fields
OrganizationTransferOwnershipPayload
Return response for transferOrganizationOwnership mutation
Fields
| Name | Description |
|---|
organization
Organization! | Updated organization |
invitationSent
Boolean! | Whether an invitation was sent (true if new owner wasn't a member) |
OrganizationUpdatePayload
Return response for updateOrganization mutation
Fields
OrgMembership
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
role
OrgMembershipRole! | |
organizationID
ID! | |
userID
ID! | |
organization
Organization! | |
user
User! | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
OrgMembershipBulkCreatePayload
Return response for createBulkOrgMembership mutation
Fields
OrgMembershipBulkDeletePayload
Return response for deleteBulkOrgMembership mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted orgMembership IDs |
OrgMembershipBulkUpdatePayload
Return response for updateBulkOrgMembership mutation
Fields
| Name | Description |
|---|
orgMemberships
[OrgMembership!] | Updated orgMemberships |
updatedIDs
[ID!] | IDs of the updated orgMemberships |
OrgMembershipConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[OrgMembershipEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
OrgMembershipCreatePayload
Return response for createOrgMembership mutation
Fields
OrgMembershipDeletePayload
Return response for deleteOrgMembership mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted orgMembership ID |
OrgMembershipEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
OrgMembership | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
OrgMembershipUpdatePayload
Return response for updateOrgMembership mutation
Fields
OrgSubscription
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
stripeSubscriptionID
String | the stripe subscription id |
stripeSubscriptionStatus
String | the status of the subscription in stripe -- see https://docs.stripe.com/api/subscriptions/object#subscription_object-status |
active
Boolean! | indicates if the subscription is active |
expiresAt
Time | the time the subscription is set to expire; only populated if subscription is cancelled |
trialExpiresAt
Time | the time the trial is set to expire |
daysUntilDue
String | number of days until there is a due payment |
owner
Organization | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
managePaymentMethods
String | |
OrgSubscriptionConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[OrgSubscriptionEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
OrgSubscriptionEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
OrgSubscription | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
PageInfo
Information about pagination in a connection.
https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo
Fields
| Name | Description |
|---|
hasNextPage
Boolean! | When paginating forwards, are there more items? |
hasPreviousPage
Boolean! | When paginating backwards, are there more items? |
startCursor
Cursor | When paginating backwards, the cursor to continue. |
endCursor
Cursor | When paginating forwards, the cursor to continue. |
PersonalAccessToken
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
name
String! | the name associated with the token |
token
String! | |
expiresAt
Time | when the token expires |
description
String | a description of the token's purpose |
scopes
[String!] | |
ssoAuthorizations
SSOAuthorizationMap | SSO authorization timestamps by organization id |
lastUsedAt
Time | |
isActive
Boolean | whether the token is active |
revokedReason
String | the reason the token was revoked |
revokedBy
String | the user who revoked the token |
revokedAt
Time | when the token was revoked |
owner
User! | |
organizations
OrganizationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrganizationOrder!] | Ordering options for Organizations returned from the connection. | where
OrganizationWhereInput | Filtering options for Organizations returned from the connection. |
|
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
PersonalAccessTokenBulkCreatePayload
Return response for createBulkPersonalAccessToken mutation
Fields
PersonalAccessTokenConnection
A connection to a list of items.
Fields
PersonalAccessTokenCreatePayload
Return response for createPersonalAccessToken mutation
Fields
PersonalAccessTokenDeletePayload
Return response for deletePersonalAccessToken mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted personalAccessToken ID |
PersonalAccessTokenEdge
An edge in a connection.
Fields
PersonalAccessTokenUpdatePayload
Return response for updatePersonalAccessToken mutation
Fields
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
internalOwner
String | the internal owner for the platform when no user or group is linked |
internalOwnerUserID
ID | the internal owner user id for the platform |
internalOwnerGroupID
ID | the internal owner group id for the platform |
businessOwner
String | business owner for the platform when no user or group is linked |
businessOwnerUserID
ID | the business owner user id for the platform |
businessOwnerGroupID
ID | the business owner group id for the platform |
technicalOwner
String | technical owner for the platform when no user or group is linked |
technicalOwnerUserID
ID | the technical owner user id for the platform |
technicalOwnerGroupID
ID | the technical owner group id for the platform |
securityOwner
String | security owner for the platform when no user or group is linked |
securityOwnerUserID
ID | the security owner user id for the platform |
securityOwnerGroupID
ID | the security owner group id for the platform |
platformKindName
String | the kind of the platform |
platformKindID
ID | the kind of the platform |
platformDataClassificationName
String | the data_classification of the platform |
platformDataClassificationID
ID | the data_classification of the platform |
environmentName
String | the environment of the platform |
environmentID
ID | the environment of the platform |
scopeName
String | the scope of the platform |
scopeID
ID | the scope of the platform |
accessModelName
String | the access_model of the platform |
accessModelID
ID | the access_model of the platform |
encryptionStatusName
String | the encryption_status of the platform |
encryptionStatusID
ID | the encryption_status of the platform |
securityTierName
String | the security_tier of the platform |
securityTierID
ID | the security_tier of the platform |
criticalityName
String | the criticality of the platform |
criticalityID
ID | the criticality of the platform |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
name
String! | the name of the platform |
description
String | the description of the platform boundary |
businessPurpose
String | the business purpose of the platform |
scopeStatement
String | scope statement for the platform, used for narrative justification |
trustBoundaryDescription
String | description of the platform trust boundary |
dataFlowSummary
String | summary of platform data flows |
status
PlatformPlatformStatus! | the lifecycle status of the platform |
physicalLocation
String | physical location of the platform, if applicable |
region
String | the region where the platform operates or is hosted |
containsPii
Boolean | whether the platform stores or processes PII |
sourceType
PlatformSourceType! | the source of the platform record, e.g., manual, discovered, imported, api |
sourceIdentifier
String | the identifier used by the source system for the platform |
costCenter
String | cost center associated with the platform |
estimatedMonthlyCost
Float | estimated monthly cost for the platform |
purchaseDate
DateTime | purchase date for the platform |
platformOwnerID
ID | the id of the user who is responsible for this platform |
externalReferenceID
String | external identifier for the platform from an upstream inventory |
metadata
Map | additional metadata about the platform |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalOwnerUser
User | |
internalOwnerGroup
Group | |
businessOwnerUser
User | |
businessOwnerGroup
Group | |
technicalOwnerUser
User | |
technicalOwnerGroup
Group | |
securityOwnerUser
User | |
securityOwnerGroup
Group | |
platformKind
CustomTypeEnum | |
platformDataClassification
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
accessModel
CustomTypeEnum | |
encryptionStatus
CustomTypeEnum | |
securityTier
CustomTypeEnum | |
criticality
CustomTypeEnum | |
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
assessments
AssessmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentOrder!] | Ordering options for Assessments returned from the connection. | where
AssessmentWhereInput | Filtering options for Assessments returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
directorySyncRuns
DirectorySyncRunConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectorySyncRunOrder!] | Ordering options for DirectorySyncRuns returned from the connection. | where
DirectorySyncRunWhereInput | Filtering options for DirectorySyncRuns returned from the connection. |
|
directoryAccounts
DirectoryAccountConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryAccountOrder!] | Ordering options for DirectoryAccounts returned from the connection. | where
DirectoryAccountWhereInput | Filtering options for DirectoryAccounts returned from the connection. |
|
directoryGroups
DirectoryGroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryGroupOrder!] | Ordering options for DirectoryGroups returned from the connection. | where
DirectoryGroupWhereInput | Filtering options for DirectoryGroups returned from the connection. |
|
directoryMemberships
DirectoryMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DirectoryMembershipOrder!] | Ordering options for DirectoryMemberships returned from the connection. | where
DirectoryMembershipWhereInput | Filtering options for DirectoryMemberships returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
sourceAssets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
sourceEntities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
outOfScopeAssets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
outOfScopeVendors
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
applicableFrameworks
StandardConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[StandardOrder!] | Ordering options for Standards returned from the connection. | where
StandardWhereInput | Filtering options for Standards returned from the connection. |
|
generatedScans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
platformOwner
User | |
systemDetail
SystemDetail | |
hasPendingWorkflow
Boolean! | Indicates if this platform has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this platform has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this platform (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this platform across all workflow instances Arguments |
Return response for createBulkPlatform mutation
Fields
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[PlatformEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
Return response for createPlatform mutation
Fields
| Name | Description |
|---|
platform
Platform! | Created platform |
Return response for deletePlatform mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted platform ID |
An edge in a connection.
Fields
| Name | Description |
|---|
node
Platform | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
Return response for updatePlatform mutation
Fields
| Name | Description |
|---|
platform
Platform! | Updated platform |
Procedure
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
revision
String | revision of the object as a semver (e.g. v1.0.0), by default any update will bump the patch version, unless the revision_bump field is set |
ownerID
ID | the organization id that owns the object |
name
String! | the name of the procedure |
status
ProcedureDocumentStatus | status of the procedure, e.g. draft, published, archived, etc. |
details
String | details of the procedure |
detailsJSON
[Any!] | structured details of the procedure in JSON format |
approvalRequired
Boolean | whether approval is required for edits to the procedure |
reviewDue
Time | the date the procedure should be reviewed, calculated based on the review_frequency if not directly set |
reviewFrequency
ProcedureFrequency | the frequency at which the procedure should be reviewed, used to calculate the review_due date |
approverID
ID | the id of the group responsible for approving the procedure |
delegateID
ID | the id of the group responsible for approving the procedure |
summary
String | |
tagSuggestions
[String!] | auto-generated tag suggestions for the procedure |
dismissedTagSuggestions
[String!] | tag suggestions dismissed by the user for the procedure |
controlSuggestions
[String!] | proposed controls referenced in the procedure |
dismissedControlSuggestions
[String!] | control suggestions dismissed by the user for the procedure |
improvementSuggestions
[String!] | suggested improvements for the procedure |
dismissedImprovementSuggestions
[String!] | improvement suggestions dismissed by the user for the procedure |
url
String | This will contain the url used to create or update the procedure |
fileID
ID | This will contain the most recent file id if this procedure was created from a file |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
procedureKindName
String | the kind of the procedure |
procedureKindID
ID | the kind of the procedure |
environmentName
String | the environment of the procedure |
environmentID
ID | the environment of the procedure |
scopeName
String | the scope of the procedure |
scopeID
ID | the scope of the procedure |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
approver
Group | the group of users who are responsible for approving the procedure |
delegate
Group | temporary delegates for the procedure, used for temporary approval |
procedureKind
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
file
File | |
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this procedure has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this procedure has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this procedure (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this procedure across all workflow instances Arguments |
ProcedureBulkCreatePayload
Return response for createBulkProcedure mutation
Fields
ProcedureBulkDeletePayload
Return response for deleteBulkProcedure mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted export IDs |
ProcedureBulkUpdatePayload
Return response for updateBulkProcedure mutation
Fields
| Name | Description |
|---|
procedures
[Procedure!] | Updated procedures |
updatedIDs
[ID!] | IDs of the updated procedures |
ProcedureConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ProcedureEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ProcedureCreatePayload
Return response for createProcedure mutation
Fields
| Name | Description |
|---|
procedure
Procedure! | Created procedure |
ProcedureDeletePayload
Return response for deleteProcedure mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted procedure ID |
ProcedureEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Procedure | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ProcedureUpdatePayload
Return response for updateProcedure mutation
Fields
| Name | Description |
|---|
procedure
Procedure! | Updated procedure |
Program
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
programKindName
String | the kind of the program |
programKindID
ID | the kind of the program |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
name
String! | the name of the program |
description
String | the description of the program |
status
ProgramProgramStatus! | the status of the program |
frameworkName
String | the short name of the compliance standard the program is based on, only used for framework type programs |
startDate
Time | the start date of the period |
endDate
Time | the end date of the period |
auditorReady
Boolean! | is the program ready for the auditor |
auditorWriteComments
Boolean! | can the auditor write comments |
auditorReadComments
Boolean! | can the auditor read comments |
auditFirm
String | the name of the audit firm conducting the audit |
auditor
String | the full name of the auditor conducting the audit |
auditorEmail
String | the email of the auditor conducting the audit |
programOwnerID
ID | the id of the user who is responsible for this program |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
programKind
CustomTypeEnum | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
notes
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
systemDetail
SystemDetail | |
users
UserConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[UserOrder!] | Ordering options for Users returned from the connection. | where
UserWhereInput | Filtering options for Users returned from the connection. |
|
programOwner
User | |
members
ProgramMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramMembershipOrder!] | Ordering options for ProgramMemberships returned from the connection. | where
ProgramMembershipWhereInput | Filtering options for ProgramMemberships returned from the connection. |
|
ProgramBulkCreatePayload
Return response for createBulkProgram mutation
Fields
| Name | Description |
|---|
programs
[Program!] | Created programs |
ProgramBulkDeletePayload
Return response for deleteBulkProgram mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted program IDs |
ProgramBulkUpdatePayload
Return response for updateBulkProgram mutation
Fields
| Name | Description |
|---|
programs
[Program!] | Updated programs |
updatedIDs
[ID!] | IDs of the updated programs |
ProgramConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ProgramEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ProgramCreatePayload
Return response for createProgram mutation
Fields
| Name | Description |
|---|
program
Program! | Created program |
ProgramDeletePayload
Return response for deleteProgram mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted program ID |
ProgramEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Program | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ProgramMembership
Implements
Fields
ProgramMembershipBulkCreatePayload
Return response for createBulkProgramMembership mutation
Fields
ProgramMembershipBulkDeletePayload
Return response for deleteBulkProgramMembership mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted programMembership IDs |
ProgramMembershipBulkUpdatePayload
Return response for updateBulkProgramMembership mutation
Fields
| Name | Description |
|---|
programMemberships
[ProgramMembership!] | Updated programMemberships |
updatedIDs
[ID!] | IDs of the updated programMemberships |
ProgramMembershipConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ProgramMembershipEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ProgramMembershipCreatePayload
Return response for createProgramMembership mutation
Fields
ProgramMembershipDeletePayload
Return response for deleteProgramMembership mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted programMembership ID |
ProgramMembershipEdge
An edge in a connection.
Fields
ProgramMembershipUpdatePayload
Return response for updateProgramMembership mutation
Fields
ProgramUpdatePayload
Return response for updateProgram mutation
Fields
| Name | Description |
|---|
program
Program! | Updated program |
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the remediation |
environmentID
ID | the environment of the remediation |
scopeName
String | the scope of the remediation |
scopeID
ID | the scope of the remediation |
externalID
String | external identifier from the integration source for the remediation |
externalOwnerID
String | external identifier from the integration source for the remediation |
title
String | title or short description of the remediation effort |
state
String | state of the remediation, such as pending or completed |
intent
String | intent or goal of the remediation effort |
summary
String | summary of the remediation approach |
explanation
String | detailed explanation of the remediation steps |
instructions
String | specific instructions or steps to implement the remediation |
ownerReference
String | reference to the owner responsible for remediation |
repositoryURI
String | source code repository URI associated with the remediation |
pullRequestURI
String | pull request URI associated with the remediation |
ticketReference
String | reference to a tracking ticket for the remediation |
dueAt
DateTime | timestamp when the remediation is due |
completedAt
DateTime | timestamp when the remediation was completed |
prGeneratedAt
DateTime | timestamp when an automated pull request was generated |
error
String | details about any errors encountered during remediation automation |
source
String | system that produced the remediation record |
externalURI
String | link to the remediation in the source system |
metadata
Map | raw metadata payload for the remediation from the source system |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
Return response for createBulkRemediation mutation
Fields
Return response for deleteBulkRemediation mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted remediation IDs |
Return response for updateBulkRemediation mutation
Fields
| Name | Description |
|---|
remediations
[Remediation!] | Updated remediations |
updatedIDs
[ID!] | IDs of the updated remediations |
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[RemediationEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
Return response for createRemediation mutation
Fields
Return response for deleteRemediation mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted remediation ID |
An edge in a connection.
Fields
| Name | Description |
|---|
node
Remediation | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
Return response for updateRemediation mutation
Fields
Review
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the review |
environmentID
ID | the environment of the review |
scopeName
String | the scope of the review |
scopeID
ID | the scope of the review |
externalID
String | external identifier from the integration source for the review |
externalOwnerID
String | external identifier from the integration source for the review |
title
String! | title of the review |
state
String | state of the review |
category
String | category for the review record |
classification
String | classification or sensitivity of the review record |
summary
String | summary text for the review |
details
String | detailed notes captured during the review |
reporter
String | person or system that created the review |
approved
Boolean | true when the review has been approved |
reviewedAt
DateTime | timestamp when the review was completed |
reportedAt
DateTime | timestamp when the review was reported or opened |
approvedAt
DateTime | timestamp when the review was approved |
reviewerID
ID | identifier for the user primarily responsible for the review |
source
String | system that produced the review record |
externalURI
String | link to the review in the source system |
metadata
Map | raw metadata payload for the review from the source system |
rawPayload
Map | raw payload received from the integration for auditing and troubleshooting |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
reviewer
User | primary reviewer responsible for the record |
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
ReviewBulkCreatePayload
Return response for createBulkReview mutation
Fields
| Name | Description |
|---|
reviews
[Review!] | Created reviews |
ReviewBulkDeletePayload
Return response for deleteBulkReview mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterNDARequest IDs |
ReviewBulkUpdatePayload
Return response for updateBulkReview mutation
Fields
| Name | Description |
|---|
reviews
[Review!] | Updated reviews |
updatedIDs
[ID!] | IDs of the updated reviews |
ReviewConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ReviewEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ReviewCreatePayload
Return response for createReview mutation
Fields
| Name | Description |
|---|
review
Review! | Created review |
ReviewDeletePayload
Return response for deleteReview mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted review ID |
ReviewEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Review | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ReviewUpdatePayload
Return response for updateReview mutation
Fields
| Name | Description |
|---|
review
Review! | Updated review |
Risk
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
riskKindName
String | the kind of the risk |
riskKindID
ID | the kind of the risk |
riskCategoryName
String | the category of the risk |
riskCategoryID
ID | the category of the risk |
environmentName
String | the environment of the risk |
environmentID
ID | the environment of the risk |
scopeName
String | the scope of the risk |
scopeID
ID | the scope of the risk |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
name
String! | the name of the risk |
status
RiskRiskStatus | status of the risk - identified, mitigated, accepted, closed, transferred, and archived. |
impact
RiskRiskImpact | impact of the risk -critical, high, medium, low |
likelihood
RiskRiskLikelihood | likelihood of the risk occurring; unlikely, likely, highly likely |
score
Int | score of the risk based on impact and likelihood (1-4 unlikely, 5-9 likely, 10-16 highly likely, 17-20 critical) |
mitigation
String | mitigation for the risk |
mitigationJSON
[Any!] | structured details of the mitigation in JSON format |
details
String | details of the risk |
detailsJSON
[Any!] | structured details of the risk in JSON format |
businessCosts
String | business costs associated with the risk |
businessCostsJSON
[Any!] | structured details of the business costs in JSON format |
stakeholderID
ID | the id of the group responsible for risk oversight |
delegateID
ID | the id of the group responsible for risk oversight on behalf of the stakeholder |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
riskKind
CustomTypeEnum | |
riskCategory
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
stakeholder
Group | the group of users who are responsible for risk oversight |
delegate
Group | temporary delegates for the risk, used for temporary ownership |
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
RiskBulkCreatePayload
Return response for createBulkRisk mutation
Fields
| Name | Description |
|---|
risks
[Risk!] | Created risks |
RiskBulkDeletePayload
Return response for deleteBulkRisk mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted risk IDs |
RiskBulkUpdatePayload
Return response for updateBulkRisk mutation
Fields
| Name | Description |
|---|
risks
[Risk!] | Updated risks |
updatedIDs
[ID!] | IDs of the updated risks |
RiskConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[RiskEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
RiskCreatePayload
Return response for createRisk mutation
Fields
| Name | Description |
|---|
risk
Risk! | Created risk |
RiskDeletePayload
Return response for deleteRisk mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted risk ID |
RiskEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Risk | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
RiskUpdatePayload
Return response for updateRisk mutation
Fields
| Name | Description |
|---|
risk
Risk! | Updated risk |
Scan
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
reviewedBy
String | who reviewed the scan when no user or group is linked |
reviewedByUserID
ID | the user id that reviewed the scan |
reviewedByGroupID
ID | the group id that reviewed the scan |
assignedTo
String | who the scan is assigned to when no user or group is linked |
assignedToUserID
ID | the user id assigned to the scan |
assignedToGroupID
ID | the group id assigned to the scan |
environmentName
String | the environment of the scan |
environmentID
ID | the environment of the scan |
scopeName
String | the scope of the scan |
scopeID
ID | the scope of the scan |
target
String! | the target of the scan, e.g., a domain name or IP address, codebase |
scanType
ScanScanType! | the type of scan, e.g., domain scan, vulnerability scan, provider scan |
metadata
Map | additional metadata for the scan, e.g., scan configuration, options, etc |
scanDate
DateTime | when the scan was executed |
scanSchedule
String | cron schedule that governs the scan cadence, in cron 6-field syntax |
nextScanRunAt
DateTime | when the scan is scheduled to run next |
performedBy
String | who performed the scan when no user or group is linked |
performedByUserID
ID | the user id that performed the scan |
performedByGroupID
ID | the group id that performed the scan |
generatedByPlatformID
ID | the platform that generated the scan |
vulnerabilityIds
[String!] | identifiers of vulnerabilities discovered during the scan |
status
ScanScanStatus! | the status of the scan, e.g., processing, completed, failed |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
reviewedByUser
User | |
reviewedByGroup
Group | |
assignedToUser
User | |
assignedToGroup
Group | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
vulnerabilities
VulnerabilityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[VulnerabilityOrder!] | Ordering options for Vulnerabilities returned from the connection. | where
VulnerabilityWhereInput | Filtering options for Vulnerabilities returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
generatedByPlatform
Platform | |
performedByUser
User | |
performedByGroup
Group | |
ScanBulkCreatePayload
Return response for createBulkScan mutation
Fields
| Name | Description |
|---|
scans
[Scan!] | Created scans |
ScanBulkDeletePayload
Return response for deleteBulkScan mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted scan IDs |
ScanBulkUpdatePayload
Return response for updateBulkScan mutation
Fields
| Name | Description |
|---|
scans
[Scan!] | Updated scans |
updatedIDs
[ID!] | IDs of the updated scans |
ScanConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ScanEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ScanCreatePayload
Return response for createScan mutation
Fields
| Name | Description |
|---|
scan
Scan! | Created scan |
ScanDeletePayload
Return response for deleteScan mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted scan ID |
ScanEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Scan | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ScanUpdatePayload
Return response for updateScan mutation
Fields
| Name | Description |
|---|
scan
Scan! | Updated scan |
ScheduledJob
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
ownerID
ID | the ID of the organization owner of the object |
jobID
ID! | the scheduled_job id to take the script to run from |
active
Boolean! | whether the scheduled job is active |
configuration
JobConfiguration | the json configuration to run this job, which could be used to template a job, e.g. { "account_name": "my-account" } |
cron
String | cron 6-field syntax, defaults to the job template's cron if not provided |
jobRunnerID
ID | the runner that this job will run on. If not set, it will scheduled on a general runner instead |
owner
Organization | |
jobTemplate
JobTemplate! | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
jobRunner
JobRunner | |
ScheduledJobBulkCreatePayload
Return response for createBulkScheduledJob mutation
Fields
ScheduledJobBulkDeletePayload
Return response for deleteBulkScheduledJob mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted scheduledJob IDs |
ScheduledJobBulkUpdatePayload
Return response for updateBulkScheduledJob mutation
Fields
| Name | Description |
|---|
scheduledJobs
[ScheduledJob!] | Updated scheduledJobs |
updatedIDs
[ID!] | IDs of the updated scheduledJobs |
ScheduledJobConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ScheduledJobEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ScheduledJobCreatePayload
Return response for createScheduledJob mutation
Fields
ScheduledJobDeletePayload
Return response for deleteScheduledJob mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted scheduledJob ID |
ScheduledJobEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
ScheduledJob | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ScheduledJobRun
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
jobRunnerID
ID! | The runner that this job will be executed on. Useful to know because of self hosted runners |
status
ScheduledJobRunScheduledJobRunStatus! | The status of the job to be executed. By default will be pending but when
scheduled on a runner, this will change to acquired. |
scheduledJobID
ID! | the parent job for this run |
expectedExecutionTime
Time! | When should this job execute on the agent. Since we might potentially schedule a few minutes before |
script
String! | the script that will be executed by the agent.
This script will be templated with the values from the configuration on the job |
owner
Organization | |
scheduledJob
ScheduledJob! | |
jobRunner
JobRunner! | |
ScheduledJobRunConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[ScheduledJobRunEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
ScheduledJobRunCreatePayload
Return response for createScheduledJobRun mutation
Fields
ScheduledJobRunDeletePayload
Return response for deleteScheduledJobRun mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted scheduledJobRun ID |
ScheduledJobRunEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
ScheduledJobRun | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
ScheduledJobRunUpdatePayload
Return response for updateScheduledJobRun mutation
Fields
ScheduledJobUpdatePayload
Return response for updateScheduledJob mutation
Fields
SearchContext
SearchContext provides information about why a particular entity matched the search query
Fields
| Name | Description |
|---|
entityID
String! | The ID of the entity that matched |
entityType
String! | The type of entity (e.g., "ActionPlan", "Control", "User") |
matchedFields
[String!]! | The fields that matched the search query |
snippets
[SearchSnippet!] | Optional snippets showing the matched content with context |
SearchResults
Fields
SearchSnippet
SearchSnippet represents a piece of matched content with surrounding context
Fields
| Name | Description |
|---|
field
String! | The field name where the match occurred |
text
String! | The matched text with surrounding context (with highlighting markers if applicable) |
Standard
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
revision
String | revision of the object as a semver (e.g. v1.0.0), by default any update will bump the patch version, unless the revision_bump field is set |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | the long name of the standard body |
shortName
String | short name of the standard, e.g. SOC 2, ISO 27001, etc. |
framework
String | unique identifier of the standard with version |
description
String | long description of the standard with details of what is covered |
governingBodyLogoURL
String | URL to the logo of the governing body |
governingBody
String | governing body of the standard, e.g. AICPA, etc. |
domains
[String!] | domains the standard covers, e.g. availability, confidentiality, etc. |
link
String | link to the official standard documentation |
status
StandardStandardStatus | status of the standard - active, draft, and archived |
isPublic
Boolean | indicates if the standard should be made available to all users, only for system owned standards |
freeToUse
Boolean | indicates if the standard is freely distributable under a trial license, only for system owned standards |
standardType
String | type of the standard - cybersecurity, healthcare , financial, etc. |
version
String | version of the standard |
logoFileID
ID | URL of the logo |
owner
Organization | |
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
trustCenterCompliances
TrustCenterComplianceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterComplianceOrder!] | Ordering options for TrustCenterCompliances returned from the connection. | where
TrustCenterComplianceWhereInput | Filtering options for TrustCenterCompliances returned from the connection. |
|
trustCenterDocs
TrustCenterDocConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterDocOrder!] | Ordering options for TrustCenterDocs returned from the connection. | where
TrustCenterDocWhereInput | Filtering options for TrustCenterDocs returned from the connection. |
|
applicablePlatforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
logoFile
File | |
StandardBulkCreatePayload
Return response for createBulkStandard mutation
Fields
StandardConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[StandardEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
StandardCreatePayload
Return response for createStandard mutation
Fields
| Name | Description |
|---|
standard
Standard! | Created standard |
StandardDeletePayload
Return response for deleteStandard mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted standard ID |
StandardEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Standard | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
StandardUpdatePayload
Return response for updateStandard mutation
Fields
| Name | Description |
|---|
standard
Standard! | Updated standard |
Subcontrol
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
title
String | human readable title of the control for quick identification |
description
String | description of what the control is supposed to accomplish |
descriptionJSON
[Any!] | structured details of the control in JSON format |
aliases
[String!] | additional names (ref_codes) for the control |
referenceID
String | internal reference id of the control, can be used for internal tracking |
auditorReferenceID
String | external auditor id of the control, can be used to map to external audit partner mappings |
responsiblePartyID
ID | the id of the party responsible for the control, usually used when the control is implemented by a third party |
status
SubcontrolControlStatus | status of the control |
implementationStatus
SubcontrolControlImplementationStatus | OSCAL-aligned implementation status of the control |
implementationDescription
String | narrative describing current implementation state for OSCAL export |
source
SubcontrolControlSource | source of the control, e.g. framework, template, custom, etc. |
referenceFramework
String | the reference framework for the control if it came from a standard, empty if not associated with a standard |
referenceFrameworkRevision
String | the reference framework revision for the control if it came from a standard, empty if not associated with a standard, allows for pulling in updates when the standard is updated |
category
String | category of the control |
categoryID
String | category id of the control |
subcategory
String | subcategory of the control |
mappedCategories
[String!] | mapped categories of the control to other standards |
assessmentObjectives
[AssessmentObjective!] | objectives of the audit assessment for the control |
assessmentMethods
[AssessmentMethod!] | methods used to verify the control implementation during an audit |
controlQuestions
[String!] | questions to ask to verify the control |
implementationGuidance
[ImplementationGuidance!] | implementation guidance for the control |
exampleEvidence
[ExampleEvidence!] | examples of evidence for the control |
references
[Reference!] | references for the control |
testingProcedures
[TestingProcedures!] | reference steps to take to test the control |
evidenceRequests
[EvidenceRequests!] | list of common evidence requests for the control |
controlOwnerID
ID | the id of the group that owns the control |
delegateID
ID | the id of the group that is temporarily delegated to own the control |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
subcontrolKindName
String | the kind of the subcontrol |
subcontrolKindID
ID | the kind of the subcontrol |
workflowEligibleMarker
Boolean | internal marker field for workflow eligibility, not exposed in API |
refCode
String! | the unique reference code for the control |
controlID
ID! | the id of the parent control |
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
narratives
NarrativeConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NarrativeOrder!] | Ordering options for Narratives returned from the connection. | where
NarrativeWhereInput | Filtering options for Narratives returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
discussions
DiscussionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DiscussionOrder!] | Ordering options for Discussions returned from the connection. | where
DiscussionWhereInput | Filtering options for Discussions returned from the connection. |
|
controlOwner
Group | the group of users who are responsible for the control, will be assigned tasks, approval, etc. |
delegate
Group | temporary delegate for the control, used for temporary control ownership |
responsibleParty
Entity | the entity who is responsible for the control implementation when it is a third party |
owner
Organization | |
subcontrolKind
CustomTypeEnum | |
control
Control! | |
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
scheduledJobs
ScheduledJobConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScheduledJobOrder!] | Ordering options for ScheduledJobs returned from the connection. | where
ScheduledJobWhereInput | Filtering options for ScheduledJobs returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
hasPendingWorkflow
Boolean! | Indicates if this subcontrol has pending changes awaiting workflow approval |
hasWorkflowHistory
Boolean! | Indicates if this subcontrol has any workflow history (completed or failed instances) |
activeWorkflowInstances
[WorkflowInstance!]! | Returns active workflow instances for this subcontrol (RUNNING or PAUSED) |
workflowTimeline
WorkflowEventConnection! | Returns the workflow event timeline for this subcontrol across all workflow instances Arguments |
SubcontrolBulkCreatePayload
Return response for createBulkSubcontrol mutation
Fields
SubcontrolBulkDeletePayload
Return response for deleteBulkSubcontrol mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted subcontrol IDs |
SubcontrolBulkUpdatePayload
Return response for updateBulkSubcontrol mutation
Fields
| Name | Description |
|---|
subcontrols
[Subcontrol!] | Updated subcontrols |
updatedIDs
[ID!] | IDs of the updated subcontrols |
SubcontrolConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[SubcontrolEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
SubcontrolCreatePayload
Return response for createSubcontrol mutation
Fields
| Name | Description |
|---|
subcontrol
Subcontrol! | Created subcontrol |
SubcontrolDeletePayload
Return response for deleteSubcontrol mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted subcontrol ID |
SubcontrolEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Subcontrol | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
SubcontrolUpdatePayload
Return response for updateSubcontrol mutation
Fields
| Name | Description |
|---|
subcontrol
Subcontrol! | Updated subcontrol |
SubmitTrustCenterNDAResponsePayload
Fields
Subprocessor
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | name of the standard body |
description
String | description of the subprocessor |
logoRemoteURL
String | URL of the logo |
logoFileID
ID | The local logo file id, takes precedence over the logo remote URL |
owner
Organization | |
logoFile
File | |
trustCenterSubprocessors
TrustCenterSubprocessorConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterSubprocessorOrder!] | Ordering options for TrustCenterSubprocessors returned from the connection. | where
TrustCenterSubprocessorWhereInput | Filtering options for TrustCenterSubprocessors returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
SubprocessorBulkCreatePayload
Return response for createBulkSubprocessor mutation
Fields
SubprocessorBulkDeletePayload
Return response for deleteBulkSubprocessor mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted subprocessor IDs |
SubprocessorBulkUpdatePayload
Return response for updateBulkSubprocessor mutation
Fields
| Name | Description |
|---|
subprocessors
[Subprocessor!] | Updated subprocessors |
updatedIDs
[ID!] | IDs of the updated subprocessors |
SubprocessorConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[SubprocessorEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
SubprocessorCreatePayload
Return response for createSubprocessor mutation
Fields
SubprocessorDeletePayload
Return response for deleteSubprocessor mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted subprocessor ID |
SubprocessorEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Subprocessor | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
SubprocessorUpdatePayload
Return response for updateSubprocessor mutation
Fields
Subscriber
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
email
String! | email address of the subscriber |
phoneNumber
String | phone number of the subscriber |
verifiedEmail
Boolean! | indicates if the email address has been verified |
verifiedPhone
Boolean! | indicates if the phone number has been verified |
active
Boolean! | indicates if the subscriber is active or not, active users will have at least one verified contact method |
unsubscribed
Boolean! | indicates if the subscriber has unsubscribed from communications |
sendAttempts
Int! | the number of attempts made to perform email send of the subscription, maximum of 5 |
owner
Organization | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
SubscriberBulkCreatePayload
Return response for createBulkSubscriber mutation
Fields
SubscriberConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[SubscriberEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
SubscriberCreatePayload
Return response for createSubscriber mutation
Fields
| Name | Description |
|---|
subscriber
Subscriber! | Created subscriber |
SubscriberDeletePayload
Return response for deleteSubscriber mutation
Fields
| Name | Description |
|---|
email
String! | Deleted subscriber email |
SubscriberEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Subscriber | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
SubscriberUpdatePayload
Return response for updateSubscriber mutation
Fields
| Name | Description |
|---|
subscriber
Subscriber! | Updated subscriber |
SystemDetail
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
programID
ID | optional program anchor for this system detail |
platformID
ID | optional platform anchor for this system detail |
systemName
String! | system name used in OSCAL metadata |
version
String | system version used in OSCAL metadata |
description
String | system description used in OSCAL metadata |
authorizationBoundary
String | authorization boundary narrative for OSCAL export |
sensitivityLevel
SystemDetailSystemSensitivityLevel | security sensitivity level of the system |
lastReviewed
DateTime | timestamp when metadata was last reviewed |
revisionHistory
[Any!] | structured revision history for OSCAL metadata |
oscalMetadataJSON
Map | optional escape hatch for additional OSCAL metadata fields |
owner
Organization | |
program
Program | optional program this detail belongs to |
platform
Platform | optional platform this detail belongs to |
SystemDetailBulkCreatePayload
Return response for createBulkSystemDetail mutation
Fields
SystemDetailBulkDeletePayload
Return response for deleteBulkSystemDetail mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted systemDetail IDs |
SystemDetailBulkUpdatePayload
Return response for updateBulkSystemDetail mutation
Fields
| Name | Description |
|---|
systemDetails
[SystemDetail!] | Updated systemDetails |
updatedIDs
[ID!] | IDs of the updated systemDetails |
SystemDetailConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[SystemDetailEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
SystemDetailCreatePayload
Return response for createSystemDetail mutation
Fields
SystemDetailDeletePayload
Return response for deleteSystemDetail mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted systemDetail ID |
SystemDetailEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
SystemDetail | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
SystemDetailUpdatePayload
Return response for updateSystemDetail mutation
Fields
TagDefinition
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the organization id that owns the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | The name of the tag definition |
aliases
[String!] | common aliases or misspellings for the tag definition |
slug
String | The slug of the tag definition, derived from the name, unique per organization |
description
String | The description of the tag definition |
color
String | The color of the tag definition in hex format |
owner
Organization | |
TagDefinitionBulkCreatePayload
Return response for createBulkTagDefinition mutation
Fields
TagDefinitionConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TagDefinitionEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TagDefinitionCreatePayload
Return response for createTagDefinition mutation
Fields
TagDefinitionDeletePayload
Return response for deleteTagDefinition mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted tagDefinition ID |
TagDefinitionEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
TagDefinition | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TagDefinitionUpdatePayload
Return response for updateTagDefinition mutation
Fields
Task
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
taskKindName
String | the kind of the task |
taskKindID
ID | the kind of the task |
environmentName
String | the environment of the task |
environmentID
ID | the environment of the task |
scopeName
String | the scope of the task |
scopeID
ID | the scope of the task |
externalUUID
String | stable external UUID for deterministic OSCAL export and round-tripping |
title
String! | the title of the task |
details
String | the details of the task |
detailsJSON
[Any!] | structured details of the task in JSON format |
status
TaskTaskStatus! | the status of the task |
due
DateTime | the due date of the task |
completed
DateTime | the completion date of the task |
assigneeID
ID | the id of the user who was assigned the task |
assignerID
ID | the id of the user who assigned the task, can be left empty if created by the system or a service token |
systemGenerated
Boolean! | indicates if the task was generated by the system |
idempotencyKey
String | key to prevent duplicates for auto-generated task based on rules |
externalReferenceURL
[String!] | an optional external reference URL for the task |
parentTaskID
ID | the parent task this task belongs to |
owner
Organization | |
taskKind
CustomTypeEnum | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
assigner
User | |
assignee
User | |
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
internalPolicies
InternalPolicyConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[InternalPolicyOrder!] | Ordering options for InternalPolicies returned from the connection. | where
InternalPolicyWhereInput | Filtering options for InternalPolicies returned from the connection. |
|
procedures
ProcedureConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProcedureOrder!] | Ordering options for Procedures returned from the connection. | where
ProcedureWhereInput | Filtering options for Procedures returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
controlObjectives
ControlObjectiveConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlObjectiveOrder!] | Ordering options for ControlObjectives returned from the connection. | where
ControlObjectiveWhereInput | Filtering options for ControlObjectives returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
platforms
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
controlImplementations
ControlImplementationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlImplementationOrder!] | Ordering options for ControlImplementations returned from the connection. | where
ControlImplementationWhereInput | Filtering options for ControlImplementations returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
evidence
EvidenceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EvidenceOrder!] | Ordering options for Evidences returned from the connection. | where
EvidenceWhereInput | Filtering options for Evidences returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
parent
Task | |
tasks
[Task!] | |
TaskBulkCreatePayload
Return response for createBulkTask mutation
Fields
| Name | Description |
|---|
tasks
[Task!] | Created tasks |
TaskBulkDeletePayload
Return response for deleteBulkTask mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted task IDs |
TaskBulkUpdatePayload
Return response for updateBulkTask mutation
Fields
| Name | Description |
|---|
tasks
[Task!] | Updated tasks |
updatedIDs
[ID!] | IDs of the updated tasks |
TaskConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TaskEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TaskCreatePayload
Return response for createTask mutation
Fields
| Name | Description |
|---|
task
Task! | Created task |
TaskDeletePayload
Return response for deleteTask mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted task ID |
TaskEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Task | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TaskUpdatePayload
Return response for updateTask mutation
Fields
| Name | Description |
|---|
task
Task! | Updated task |
Template
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the template |
environmentID
ID | the environment of the template |
scopeName
String | the scope of the template |
scopeID
ID | the scope of the template |
name
String! | the name of the template |
templateType
TemplateDocumentType! | the type of the template, either a provided template or an implementation (document) |
description
String | the description of the template |
kind
TemplateTemplateKind | the kind of template, e.g. questionnaire |
jsonconfig
Map! | the jsonschema object of the template |
uischema
Map | the uischema for the template to render in the UI |
trustCenterID
ID | the id of the trust center this template is associated with |
owner
Organization | |
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
documents
DocumentDataConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[DocumentDataOrder!] | Ordering options for DocumentDataSlice returned from the connection. | where
DocumentDataWhereInput | Filtering options for DocumentDataSlice returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
trustCenter
TrustCenter | |
assessments
AssessmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssessmentOrder!] | Ordering options for Assessments returned from the connection. | where
AssessmentWhereInput | Filtering options for Assessments returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
identityHolders
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
TemplateBulkCreatePayload
Return response for createBulkTemplate mutation
Fields
TemplateBulkDeletePayload
Return response for deleteBulkTemplate mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted template IDs |
TemplateBulkUpdatePayload
Return response for updateBulkTemplate mutation
Fields
| Name | Description |
|---|
templates
[Template!] | Updated templates |
updatedIDs
[ID!] | IDs of the updated templates |
TemplateConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TemplateEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TemplateCreatePayload
Return response for createTemplate mutation
Fields
| Name | Description |
|---|
template
Template! | Created template |
TemplateDeletePayload
Return response for deleteTemplate mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted template ID |
TemplateEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Template | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TemplateUpdatePayload
Return response for updateTemplate mutation
Fields
| Name | Description |
|---|
template
Template! | Updated template |
TFASetting
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
verified
Boolean! | specifies if the TFA device has been verified |
totpAllowed
Boolean | specifies a user may complete authentication by verifying a TOTP code delivered through an authenticator app |
owner
User | |
TFASettingConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TFASettingEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TFASettingCreatePayload
Return response for createTFASetting mutation
Fields
TFASettingEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
TFASetting | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TFASettingUpdatePayload
Return response for updateTFASetting mutation
Fields
TrustCenter
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the organization id that owns the object |
slug
String | Slug for the trust center |
customDomainID
ID | custom domain id for the trust center |
previewDomainID
ID | preview domain id for the trust center |
pirschDomainID
String | Pirsch domain ID |
pirschIdentificationCode
String | Pirsch ID code |
pirschAccessLink
String | Pirsch access link |
previewStatus
TrustCenterTrustCenterPreviewStatus | preview status of the trust center |
subprocessorURL
String | External URL for the trust center subprocessors |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
customDomain
CustomDomain | |
previewDomain
CustomDomain | |
setting
TrustCenterSetting | |
previewSetting
TrustCenterSetting | |
watermarkConfig
TrustCenterWatermarkConfig | |
trustCenterSubprocessors
TrustCenterSubprocessorConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterSubprocessorOrder!] | Ordering options for TrustCenterSubprocessors returned from the connection. | where
TrustCenterSubprocessorWhereInput | Filtering options for TrustCenterSubprocessors returned from the connection. |
|
trustCenterDocs
TrustCenterDocConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterDocOrder!] | Ordering options for TrustCenterDocs returned from the connection. | where
TrustCenterDocWhereInput | Filtering options for TrustCenterDocs returned from the connection. |
|
trustCenterCompliances
TrustCenterComplianceConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterComplianceOrder!] | Ordering options for TrustCenterCompliances returned from the connection. | where
TrustCenterComplianceWhereInput | Filtering options for TrustCenterCompliances returned from the connection. |
|
templates
TemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TemplateOrder!] | Ordering options for Templates returned from the connection. | where
TemplateWhereInput | Filtering options for Templates returned from the connection. |
|
posts
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
trustCenterEntities
TrustCenterEntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterEntityOrder!] | Ordering options for TrustCenterEntities returned from the connection. | where
TrustCenterEntityWhereInput | Filtering options for TrustCenterEntities returned from the connection. |
|
trustCenterNdaRequests
TrustCenterNDARequestConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterNDARequestOrder!] | Ordering options for TrustCenterNDARequests returned from the connection. | where
TrustCenterNDARequestWhereInput | Filtering options for TrustCenterNDARequests returned from the connection. |
|
trustCenterFaqs
TrustCenterFAQConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterFAQOrder!] | Ordering options for TrustCenterFAQs returned from the connection. | where
TrustCenterFAQWhereInput | Filtering options for TrustCenterFAQs returned from the connection. |
|
TrustCenterAccessTokenPayload
Return response for requestNewTrustCenterToken mutation
Fields
TrustCenterCompliance
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
standardID
ID! | ID of the standard |
trustCenterID
ID | ID of the trust center |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
TrustCenter | |
standard
Standard! | |
TrustCenterComplianceBulkCreatePayload
Return response for createBulkTrustCenterCompliance mutation
Fields
TrustCenterComplianceBulkDeletePayload
Return response for deleteBulkTrustCenterCompliance mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterCompliance IDs |
TrustCenterComplianceBulkUpdatePayload
Return response for updateBulkTrustCenterCompliance mutation
Fields
| Name | Description |
|---|
trustCenterCompliances
[TrustCenterCompliance!] | Updated trustCenterCompliances |
updatedIDs
[ID!] | IDs of the updated trustCenterCompliances |
TrustCenterComplianceConnection
A connection to a list of items.
Fields
TrustCenterComplianceCreatePayload
Return response for createTrustCenterCompliance mutation
Fields
TrustCenterComplianceDeletePayload
Return response for deleteTrustCenterCompliance mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterCompliance ID |
TrustCenterComplianceEdge
An edge in a connection.
Fields
TrustCenterComplianceUpdatePayload
Return response for updateTrustCenterCompliance mutation
Fields
TrustCenterConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TrustCenterEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TrustCenterCreatePayload
Return response for createTrustCenter mutation
Fields
TrustCenterDeletePayload
Return response for deleteTrustCenter mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenter ID |
TrustCenterDoc
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
trustCenterDocKindName
String | the kind of the trust_center_doc |
trustCenterDocKindID
ID | the kind of the trust_center_doc |
trustCenterID
ID | ID of the trust center |
title
String! | title of the document |
fileID
ID | ID of the file containing the document |
originalFileID
ID | ID of the file containing the document, before any watermarking |
watermarkingEnabled
Boolean | whether watermarking is enabled for the document, this will only take effect if there is a global watermarking config for the trust center |
watermarkStatus
TrustCenterDocWatermarkStatus | status of the watermarking |
visibility
TrustCenterDocTrustCenterDocumentVisibility | visibility of the document |
standardID
ID | ID of the standard |
trustCenterDocKind
CustomTypeEnum | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
TrustCenter | |
standard
Standard | |
file
File | the file containing the document content |
originalFile
File | the file containing the document content, pre watermarking |
TrustCenterDocBulkCreatePayload
Return response for createBulkTrustCenterDoc mutation
Fields
TrustCenterDocBulkDeletePayload
Return response for deleteBulkTrustCenterDoc mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterDoc IDs |
TrustCenterDocBulkUpdatePayload
Return response for updateBulkTrustCenterDoc mutation
Fields
| Name | Description |
|---|
trustCenterDocs
[TrustCenterDoc!] | Updated trust center docs |
updatedIDs
[ID!] | IDs of the updated trust center docs |
TrustCenterDocConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TrustCenterDocEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TrustCenterDocCreatePayload
Return response for createTrustCenterDoc mutation
Fields
TrustCenterDocDeletePayload
Return response for deleteTrustCenterDoc mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterDoc ID |
TrustCenterDocEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
TrustCenterDoc | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TrustCenterDocUpdatePayload
Return response for updateTrustCenterDoc mutation
Fields
TrustCenterDomainCreatePayload
Return response for createTrustCenterDomain mutation
Fields
TrustCenterEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
TrustCenter | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TrustCenterEntity
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
logoFileID
ID | The local logo file id |
url
String | URL of customer's website |
trustCenterID
ID | The trust center this entity belongs to |
name
String! | The name of the tag definition |
entityTypeID
ID | The entity type for the customer entity |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
logoFile
File | |
trustCenter
TrustCenter | |
entityType
EntityType | |
TrustCenterEntityBulkCreatePayload
Return response for createBulkTrustCenterEntity mutation
Fields
TrustCenterEntityConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TrustCenterEntityEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TrustCenterEntityCreatePayload
Return response for createTrustCenterEntity mutation
Fields
TrustCenterEntityDeletePayload
Return response for deleteTrustCenterEntity mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterEntity ID |
TrustCenterEntityEdge
An edge in a connection.
Fields
TrustCenterEntityUpdatePayload
Return response for updateTrustCenterEntity mutation
Fields
TrustCenterFAQ
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
trustCenterFaqKindName
String | the kind of the trust_center_faq |
trustCenterFaqKindID
ID | the kind of the trust_center_faq |
noteID
ID! | ID of the note containing the FAQ question and answer |
trustCenterID
ID | ID of the trust center |
referenceLink
String | optional reference link for the FAQ |
displayOrder
Int | display order of the FAQ |
trustCenterFaqKind
CustomTypeEnum | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
TrustCenter | |
note
Note! | |
TrustCenterFAQBulkCreatePayload
Return response for createBulkTrustCenterFAQ mutation
Fields
TrustCenterFAQBulkDeletePayload
Return response for deleteBulkTrustCenterFAQ mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterFAQ IDs |
TrustCenterFAQBulkUpdatePayload
Return response for updateBulkTrustCenterFAQ mutation
Fields
| Name | Description |
|---|
trustCenterFAQs
[TrustCenterFAQ!] | Updated trustCenterFAQs |
updatedIDs
[ID!] | IDs of the updated trustCenterFAQs |
TrustCenterFAQConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[TrustCenterFAQEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
TrustCenterFAQCreatePayload
Return response for createTrustCenterFAQ mutation
Fields
TrustCenterFAQDeletePayload
Return response for deleteTrustCenterFAQ mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterFAQ ID |
TrustCenterFAQEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
TrustCenterFAQ | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
TrustCenterFAQUpdatePayload
Return response for updateTrustCenterFAQ mutation
Fields
TrustCenterNDACreatePayload
Fields
TrustCenterNDARequest
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
trustCenterID
ID | ID of the trust center |
firstName
String! | first name of the requester |
lastName
String! | last name of the requester |
email
String! | email address of the requester |
companyName
String | company name of the requester |
reason
String | reason for the NDA request |
accessLevel
TrustCenterNDARequestTrustCenterNDARequestAccessLevel | access level requested |
status
TrustCenterNDARequestTrustCenterNDARequestStatus | status of the NDA request |
approvedAt
DateTime | timestamp when the request was approved |
approvedByUserID
String | ID of the user who approved the request |
signedAt
DateTime | timestamp when the NDA was signed |
documentDataID
ID | ID of the signed NDA document data |
fileID
ID | ID of the template file at the time the NDA was signed |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
TrustCenter | |
trustCenterDocs
TrustCenterDocConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TrustCenterDocOrder!] | Ordering options for TrustCenterDocs returned from the connection. | where
TrustCenterDocWhereInput | Filtering options for TrustCenterDocs returned from the connection. |
|
document
DocumentData | the signed NDA document data |
file
File | the template file at the time the NDA was signed |
TrustCenterNDARequestBulkCreatePayload
Return response for createBulkTrustCenterNDARequest mutation
Fields
TrustCenterNDARequestBulkDeletePayload
Return response for deleteBulkTrustCenterNDARequest mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterNDARequest IDs |
TrustCenterNDARequestConnection
A connection to a list of items.
Fields
TrustCenterNDARequestCreatePayload
Return response for createTrustCenterNDARequest mutation
Fields
TrustCenterNDARequestDeletePayload
Return response for deleteTrustCenterNDARequest mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterNDARequest ID |
TrustCenterNDARequestEdge
An edge in a connection.
Fields
TrustCenterNDARequestUpdatePayload
Return response for updateTrustCenterNDARequest mutation
Fields
TrustCenterNDAUpdatePayload
Fields
TrustCenterPreviewSettingCreatePayload
Return response for createTrustCenterPreviewSetting mutation
Fields
TrustCenterSetting
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
trustCenterID
String | the ID of the trust center the settings belong to |
title
String | title of the trust center |
companyName
String | company name for the trust center, defaults to the organization's display name |
companyDescription
String | company description for the trust center |
overview
String | overview of the trust center |
logoRemoteURL
String | URL of the logo |
logoLocalFileID
ID | The local logo file id, takes precedence over the logo remote URL |
faviconRemoteURL
String | URL of the favicon |
faviconLocalFileID
ID | The local favicon file id, takes precedence over the favicon remote URL |
themeMode
TrustCenterSettingTrustCenterThemeMode | Theme mode for the trust center |
primaryColor
String | primary color for the trust center |
font
String | font for the trust center |
foregroundColor
String | foreground color for the trust center |
backgroundColor
String | background color for the trust center |
accentColor
String | accent/brand color for the trust center |
secondaryBackgroundColor
String | secondary background color for the trust center |
secondaryForegroundColor
String | secondary foreground color for the trust center |
environment
TrustCenterSettingTrustCenterEnvironment | environment of the trust center |
removeBranding
Boolean | whether to remove branding from the trust center |
companyDomain
String | URL to the company's homepage |
securityContact
String | email address for security contact |
ndaApprovalRequired
Boolean | whether NDA requests require approval before being processed |
statusPageURL
String | URL to the company's status page |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
logoFile
File | |
faviconFile
File | |
TrustCenterSettingBulkCreatePayload
Return response for createBulkTrustCenterSetting mutation
Fields
TrustCenterSettingConnection
A connection to a list of items.
Fields
TrustCenterSettingCreatePayload
Return response for createTrustCenterSetting mutation
Fields
TrustCenterSettingDeletePayload
Return response for deleteTrustCenterSetting mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterSetting ID |
TrustCenterSettingEdge
An edge in a connection.
Fields
TrustCenterSettingUpdatePayload
Return response for updateTrustCenterSetting mutation
Fields
TrustCenterSubprocessor
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
trustCenterSubprocessorKindName
String | the kind of the trust_center_subprocessor |
trustCenterSubprocessorKindID
ID | the kind of the trust_center_subprocessor |
subprocessorID
ID! | ID of the subprocessor |
trustCenterID
ID | ID of the trust center |
countries
[String!] | country codes or country where the subprocessor is located |
trustCenterSubprocessorKind
CustomTypeEnum | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
TrustCenter | |
subprocessor
Subprocessor! | |
TrustCenterSubprocessorBulkCreatePayload
Return response for createBulkTrustCenterSubprocessor mutation
Fields
TrustCenterSubprocessorBulkDeletePayload
Return response for deleteBulkTrustCenterSubprocessor mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted trustCenterSubprocessor IDs |
TrustCenterSubprocessorBulkUpdatePayload
Return response for updateBulkTrustCenterSubprocessor mutation
Fields
| Name | Description |
|---|
trustCenterSubprocessors
[TrustCenterSubprocessor!] | Updated trustCenterSubprocessors |
updatedIDs
[ID!] | IDs of the updated trustCenterSubprocessors |
TrustCenterSubprocessorConnection
A connection to a list of items.
Fields
TrustCenterSubprocessorCreatePayload
Return response for createTrustCenterSubprocessor mutation
Fields
TrustCenterSubprocessorDeletePayload
Return response for deleteTrustCenterSubprocessor mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterSubprocessor ID |
TrustCenterSubprocessorEdge
An edge in a connection.
Fields
TrustCenterSubprocessorUpdatePayload
Return response for updateTrustCenterSubprocessor mutation
Fields
TrustCenterUpdatePayload
Return response for updateTrustCenter mutation
Fields
TrustCenterWatermarkConfig
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
ownerID
ID | the ID of the organization owner of the object |
trustCenterID
String | ID of the trust center |
isEnabled
Boolean | whether the watermarking is enabled for all trust center documents, default is true |
logoID
ID | ID of the file containing the document |
text
String | text to watermark the document with |
fontSize
Float | font size of the watermark text |
opacity
Float | opacity of the watermark text |
rotation
Float | rotation of the watermark text |
color
String | color of the watermark text |
font
TrustCenterWatermarkConfigFont | font of the watermark text |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
trustCenter
[TrustCenter!] | |
file
File | the file containing the image for watermarking, if applicable |
TrustCenterWatermarkConfigBulkCreatePayload
Return response for createBulkTrustCenterWatermarkConfig mutation
Fields
TrustCenterWatermarkConfigConnection
A connection to a list of items.
Fields
TrustCenterWatermarkConfigCreatePayload
Return response for createTrustCenterWatermarkConfig mutation
Fields
TrustCenterWatermarkConfigDeletePayload
Return response for deleteTrustCenterWatermarkConfig mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted trustCenterWatermarkConfig ID |
TrustCenterWatermarkConfigEdge
An edge in a connection.
Fields
TrustCenterWatermarkConfigUpdatePayload
Return response for updateTrustCenterWatermarkConfig mutation
Fields
User
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
email
String! | |
firstName
String | |
lastName
String | |
displayName
String! | The user's displayed 'friendly' name |
avatarRemoteURL
String | URL of the user's remote avatar |
avatarLocalFileID
ID | The user's local avatar file id, takes precedence over the avatar remote URL |
avatarUpdatedAt
Time | The time the user's (local) avatar was last updated |
lastSeen
Time | the time the user was last seen |
lastLoginProvider
UserAuthProvider | the last auth provider used to login |
sub
String | the Subject of the user JWT |
authProvider
UserAuthProvider! | auth provider used to register the account |
role
UserRole | the user's role |
scimExternalID
String | the SCIM external ID for the user |
scimUsername
String | the SCIM username for the user |
scimActive
Boolean | whether the SCIM user is active |
scimPreferredLanguage
String | the SCIM preferred language for the user |
scimLocale
String | the SCIM locale for the user |
personalAccessTokens
PersonalAccessTokenConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PersonalAccessTokenOrder!] | Ordering options for PersonalAccessTokens returned from the connection. | where
PersonalAccessTokenWhereInput | Filtering options for PersonalAccessTokens returned from the connection. |
|
tfaSettings
TFASettingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TFASettingOrder!] | Ordering options for TFASettings returned from the connection. | where
TFASettingWhereInput | Filtering options for TFASettings returned from the connection. |
|
setting
UserSetting! | |
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
organizations
OrganizationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrganizationOrder!] | Ordering options for Organizations returned from the connection. | where
OrganizationWhereInput | Filtering options for Organizations returned from the connection. |
|
webauthns
WebauthnConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
WebauthnOrder | Ordering options for Webauthns returned from the connection. | where
WebauthnWhereInput | Filtering options for Webauthns returned from the connection. |
|
avatarFile
File | |
events
EventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EventOrder!] | Ordering options for Events returned from the connection. | where
EventWhereInput | Filtering options for Events returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
campaigns
CampaignConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignOrder!] | Ordering options for Campaigns returned from the connection. | where
CampaignWhereInput | Filtering options for Campaigns returned from the connection. |
|
campaignTargets
CampaignTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[CampaignTargetOrder!] | Ordering options for CampaignTargets returned from the connection. | where
CampaignTargetWhereInput | Filtering options for CampaignTargets returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
assignerTasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
assigneeTasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
programsOwned
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
platformsOwned
PlatformConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[PlatformOrder!] | Ordering options for Platforms returned from the connection. | where
PlatformWhereInput | Filtering options for Platforms returned from the connection. |
|
identityHolderProfiles
IdentityHolderConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IdentityHolderOrder!] | Ordering options for IdentityHolders returned from the connection. | where
IdentityHolderWhereInput | Filtering options for IdentityHolders returned from the connection. |
|
groupMemberships
GroupMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupMembershipOrder!] | Ordering options for GroupMemberships returned from the connection. | where
GroupMembershipWhereInput | Filtering options for GroupMemberships returned from the connection. |
|
orgMemberships
OrgMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[OrgMembershipOrder!] | Ordering options for OrgMemberships returned from the connection. | where
OrgMembershipWhereInput | Filtering options for OrgMemberships returned from the connection. |
|
programMemberships
ProgramMembershipConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramMembershipOrder!] | Ordering options for ProgramMemberships returned from the connection. | where
ProgramMembershipWhereInput | Filtering options for ProgramMemberships returned from the connection. |
|
UserBulkCreatePayload
Return response for createBulkUser mutation
Fields
| Name | Description |
|---|
users
[User!] | Created users |
UserConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[UserEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
UserCreatePayload
Return response for createUser mutation
Fields
| Name | Description |
|---|
user
User! | Created user |
UserDeletePayload
Return response for deleteUser mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted user ID |
UserEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
User | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
UserSetting
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
userID
ID | |
delegateUserID
String | user id to delegate workflow approvals to |
delegateStartAt
Time | when delegation becomes active |
delegateEndAt
Time | when delegation ends |
locked
Boolean! | user account is locked if unconfirmed or explicitly locked |
silencedAt
Time | The time notifications regarding the user were silenced |
suspendedAt
Time | The time the user was suspended |
status
UserSettingUserStatus! | status of the user account |
emailConfirmed
Boolean! | whether the user has confirmed their email address |
isWebauthnAllowed
Boolean | specifies a user may complete authentication by verifying a WebAuthn capable device |
isTfaEnabled
Boolean | whether the user has two factor authentication enabled |
user
User | |
defaultOrg
Organization | organization to load on user login |
UserSettingBulkCreatePayload
Return response for createBulkUserSetting mutation
Fields
UserSettingBulkDeletePayload
Return response for deleteBulkUserSetting mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted userSetting IDs |
UserSettingBulkUpdatePayload
Return response for updateBulkUserSetting mutation
Fields
| Name | Description |
|---|
userSettings
[UserSetting!] | Updated userSettings |
updatedIDs
[ID!] | IDs of the updated userSettings |
UserSettingConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[UserSettingEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
UserSettingCreatePayload
Return response for createUserSetting mutation
Fields
UserSettingEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
UserSetting | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
UserSettingUpdatePayload
Return response for updateUserSetting mutation
Fields
UserUpdatePayload
Return response for updateUser mutation
Fields
| Name | Description |
|---|
user
User! | Updated user |
Vulnerability
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
environmentName
String | the environment of the vulnerability |
environmentID
ID | the environment of the vulnerability |
scopeName
String | the scope of the vulnerability |
scopeID
ID | the scope of the vulnerability |
externalOwnerID
String | owner of the vulnerability |
externalID
String! | external identifier from the integration source for the vulnerability |
cveID
String | CVE identifier for the vulnerability when applicable |
source
String | system that produced the vulnerability record |
displayName
String | display name for the vulnerability when provided |
category
String | category of the vulnerability such as application or infrastructure |
severity
String | severity label for the vulnerability |
score
Float | overall score such as CVSS for the vulnerability |
impact
Float | impact score or rating for the vulnerability |
exploitability
Float | exploitability score or rating for the vulnerability |
priority
String | priority assigned to the vulnerability |
status
String | lifecycle status of the vulnerability |
summary
String | short summary of the vulnerability details |
description
String | long form description of the vulnerability |
vector
String | attack vector string such as a CVSS vector |
remediationSLA
Int | remediation service level agreement in days |
open
Boolean | indicates if the vulnerability is still open |
blocking
Boolean | true when the vulnerability blocks production changes |
production
Boolean | true when the vulnerability affects production systems |
public
Boolean | true when the vulnerability is publicly disclosed |
validated
Boolean | true when the vulnerability has been validated by the security team |
references
[String!] | reference links for the vulnerability |
impacts
[String!] | targets or assets impacted by the vulnerability |
publishedAt
DateTime | timestamp when the vulnerability was published |
discoveredAt
DateTime | timestamp when the vulnerability was discovered in the environment |
sourceUpdatedAt
DateTime | timestamp when the source last updated the vulnerability |
externalURI
String | link to the vulnerability in the source system |
metadata
Map | raw metadata payload for the vulnerability from the source system |
rawPayload
Map | raw payload received from the integration for auditing and troubleshooting |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
environment
CustomTypeEnum | |
scope
CustomTypeEnum | |
integrations
IntegrationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[IntegrationOrder!] | Ordering options for Integrations returned from the connection. | where
IntegrationWhereInput | Filtering options for Integrations returned from the connection. |
|
findings
FindingConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FindingOrder!] | Ordering options for Findings returned from the connection. | where
FindingWhereInput | Filtering options for Findings returned from the connection. |
|
actionPlans
ActionPlanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ActionPlanOrder!] | Ordering options for ActionPlans returned from the connection. | where
ActionPlanWhereInput | Filtering options for ActionPlans returned from the connection. |
|
controls
ControlConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ControlOrder!] | Ordering options for Controls returned from the connection. | where
ControlWhereInput | Filtering options for Controls returned from the connection. |
|
subcontrols
SubcontrolConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[SubcontrolOrder!] | Ordering options for Subcontrols returned from the connection. | where
SubcontrolWhereInput | Filtering options for Subcontrols returned from the connection. |
|
risks
RiskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RiskOrder!] | Ordering options for Risks returned from the connection. | where
RiskWhereInput | Filtering options for Risks returned from the connection. |
|
programs
ProgramConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ProgramOrder!] | Ordering options for Programs returned from the connection. | where
ProgramWhereInput | Filtering options for Programs returned from the connection. |
|
assets
AssetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[AssetOrder!] | Ordering options for Assets returned from the connection. | where
AssetWhereInput | Filtering options for Assets returned from the connection. |
|
entities
EntityConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EntityOrder!] | Ordering options for Entities returned from the connection. | where
EntityWhereInput | Filtering options for Entities returned from the connection. |
|
scans
ScanConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ScanOrder!] | Ordering options for Scans returned from the connection. | where
ScanWhereInput | Filtering options for Scans returned from the connection. |
|
tasks
TaskConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TaskOrder!] | Ordering options for Tasks returned from the connection. | where
TaskWhereInput | Filtering options for Tasks returned from the connection. |
|
remediations
RemediationConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[RemediationOrder!] | Ordering options for Remediations returned from the connection. | where
RemediationWhereInput | Filtering options for Remediations returned from the connection. |
|
reviews
ReviewConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[ReviewOrder!] | Ordering options for Reviews returned from the connection. | where
ReviewWhereInput | Filtering options for Reviews returned from the connection. |
|
comments
NoteConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NoteOrder!] | Ordering options for Notes returned from the connection. | where
NoteWhereInput | Filtering options for Notes returned from the connection. |
|
files
FileConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[FileOrder!] | Ordering options for Files returned from the connection. | where
FileWhereInput | Filtering options for Files returned from the connection. |
|
VulnerabilityBulkCreatePayload
Return response for createBulkVulnerability mutation
Fields
VulnerabilityBulkDeletePayload
Return response for deleteBulkVulnerability mutation
Fields
| Name | Description |
|---|
deletedIDs
[ID!]! | Deleted vulnerability IDs |
VulnerabilityBulkUpdatePayload
Return response for updateBulkVulnerability mutation
Fields
| Name | Description |
|---|
vulnerabilities
[Vulnerability!] | Updated vulnerabilities |
updatedIDs
[ID!] | IDs of the updated vulnerabilities |
VulnerabilityConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[VulnerabilityEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
VulnerabilityCreatePayload
Return response for createVulnerability mutation
Fields
VulnerabilityDeletePayload
Return response for deleteVulnerability mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted vulnerability ID |
VulnerabilityEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Vulnerability | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
VulnerabilityResolvePayload
Return response for resolveVulnerability mutation
Fields
| Name | Description |
|---|
vulnerability
Vulnerability! | Resolved vulnerability |
review
Review | Review record created for the resolution, if requested |
VulnerabilitySummary
Aggregated vulnerability summary for dashboards.
Fields
VulnerabilitySummaryBucket
Summary bucket for vulnerability groupings.
Fields
| Name | Description |
|---|
key
String! | Bucket label such as severity or source. |
count
Int! | Count of vulnerabilities in this bucket. |
VulnerabilityUpdatePayload
Return response for updateVulnerability mutation
Fields
Webauthn
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
aaguid
AAGUID! | The AAGUID of the authenticator; AAGUID is defined as an array containing the globally unique identifier of the authenticator model being sought |
backupEligible
Boolean! | Flag backup eligible indicates the credential is able to be backed up and/or sync'd between devices. This should NEVER change |
backupState
Boolean! | Flag backup state indicates the credential has been backed up and/or sync'd |
owner
User! | |
WebauthnConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[WebauthnEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
WebauthnDeletePayload
Return response for deleteWebauthn mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted webauthn ID |
WebauthnEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
Webauthn | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
WorkflowAssignment
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
workflowInstanceID
ID! | ID of the workflow instance this assignment belongs to |
assignmentKey
String! | Unique key for the assignment within the workflow instance |
role
String! | Role assigned to the target, e.g. APPROVER |
label
String | Optional label for the assignment |
required
Boolean! | Whether this assignment is required for workflow progression |
status
WorkflowAssignmentWorkflowAssignmentStatus! | Current status of the assignment |
metadata
Map | Optional metadata for the assignment |
approvalMetadata
WorkflowAssignmentApproval | structured approval metadata |
rejectionMetadata
WorkflowAssignmentRejection | structured rejection metadata |
invalidationMetadata
WorkflowAssignmentInvalidation | structured invalidation metadata |
decidedAt
Time | Timestamp when the assignment was decided |
actorUserID
ID | User who made the decision |
actorGroupID
ID | Group that acted on the decision (if applicable) |
notes
String | Optional notes about the assignment |
dueAt
Time | Timestamp when the assignment is due for delegation or escalation checks |
owner
Organization | |
workflowInstance
WorkflowInstance! | Instance this assignment belongs to |
workflowAssignmentTargets
WorkflowAssignmentTargetConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowAssignmentTargetOrder!] | Ordering options for WorkflowAssignmentTargets returned from the connection. | where
WorkflowAssignmentTargetWhereInput | Filtering options for WorkflowAssignmentTargets returned from the connection. |
|
user
User | User who acted on this assignment |
group
Group | Group that acted on this assignment |
WorkflowAssignmentApprovePayload
Return response for approveWorkflowAssignment mutation
Fields
WorkflowAssignmentConnection
A connection to a list of items.
Fields
WorkflowAssignmentEdge
An edge in a connection.
Fields
WorkflowAssignmentReassignPayload
Return response for adminReassignWorkflowAssignment mutation
Fields
WorkflowAssignmentRejectPayload
Return response for rejectWorkflowAssignment mutation
Fields
WorkflowAssignmentTarget
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
workflowAssignmentID
ID! | Assignment this target belongs to |
targetType
WorkflowAssignmentTargetWorkflowTargetType! | Type of the target (USER, GROUP, ROLE, RESOLVER) |
targetUserID
ID | User target when target_type is USER |
targetGroupID
ID | Group target when target_type is GROUP |
resolverKey
String | Resolver key when target_type is RESOLVER |
owner
Organization | |
workflowAssignment
WorkflowAssignment! | Assignment this target belongs to |
user
User | User target when target_type is USER |
group
Group | Group target when target_type is GROUP |
WorkflowAssignmentTargetConnection
A connection to a list of items.
Fields
WorkflowAssignmentTargetEdge
An edge in a connection.
Fields
WorkflowDefinition
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
systemOwned
Boolean | indicates if the record is owned by the the openlane system and not by an organization |
internalNotes
String | internal notes about the object creation, this field is only available to system admins |
systemInternalID
String | an internal identifier for the mapping, this field is only available to system admins |
name
String! | Name of the workflow definition |
description
String | Optional description of the workflow definition |
workflowKind
WorkflowDefinitionWorkflowKind! | Kind of workflow, e.g. APPROVAL, LIFECYCLE, NOTIFICATION |
schemaType
String! | Type of schema this workflow applies to |
revision
Int! | Revision number for this definition |
draft
Boolean! | Whether this definition is a draft |
publishedAt
Time | When this definition was published |
cooldownSeconds
Int! | Suppress duplicate triggers within this window per object/definition |
isDefault
Boolean! | Whether this is the default workflow for the schema type |
active
Boolean! | Whether the workflow definition is active |
definitionJSON
WorkflowDefinitionDocument | Typed document describing triggers, conditions, and actions |
trackedFields
[String!] | Cached list of fields that should trigger workflow evaluation |
owner
Organization | |
blockedGroups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
editors
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
viewers
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
tagDefinitions
TagDefinitionConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[TagDefinitionOrder!] | Ordering options for TagDefinitions returned from the connection. | where
TagDefinitionWhereInput | Filtering options for TagDefinitions returned from the connection. |
|
groups
GroupConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[GroupOrder!] | Ordering options for Groups returned from the connection. | where
GroupWhereInput | Filtering options for Groups returned from the connection. |
|
notificationTemplates
NotificationTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[NotificationTemplateOrder!] | Ordering options for NotificationTemplates returned from the connection. | where
NotificationTemplateWhereInput | Filtering options for NotificationTemplates returned from the connection. |
|
emailTemplates
EmailTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailTemplateOrder!] | Ordering options for EmailTemplates returned from the connection. | where
EmailTemplateWhereInput | Filtering options for EmailTemplates returned from the connection. |
|
WorkflowDefinitionBulkCreatePayload
Return response for createBulkWorkflowDefinition mutation
Fields
WorkflowDefinitionConnection
A connection to a list of items.
Fields
WorkflowDefinitionCreatePayload
Return response for createWorkflowDefinition mutation
Fields
WorkflowDefinitionDeletePayload
Return response for deleteWorkflowDefinition mutation
Fields
| Name | Description |
|---|
deletedID
ID! | Deleted workflowDefinition ID |
WorkflowDefinitionEdge
An edge in a connection.
Fields
WorkflowDefinitionUpdatePayload
Return response for updateWorkflowDefinition mutation
Fields
WorkflowEvent
Implements
Fields
WorkflowEventConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[WorkflowEventEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
WorkflowEventEdge
An edge in a connection.
Fields
| Name | Description |
|---|
node
WorkflowEvent | The item at the end of the edge. |
cursor
Cursor! | A cursor for use in pagination. |
WorkflowFieldDiff
WorkflowFieldDiff describes a proposed change for a single field.
Fields
| Name | Description |
|---|
field
String! | Field name (snake_case) |
label
String | Human-friendly field label when available |
type
String | Field type metadata when available |
currentValue
Any | Current field value |
proposedValue
Any | Proposed field value |
diff
String | Unified diff for the field (when applicable) |
Metadata for a workflow-eligible field
Fields
| Name | Description |
|---|
name
String! | The field name (snake_case) |
label
String! | Human-readable label for the field |
type
String! | Field data type |
WorkflowInstance
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
workflowDefinitionID
ID! | ID of the workflow definition this instance is based on |
workflowProposalID
ID | ID of the workflow proposal this instance is associated with (when approval-before-commit is used) |
state
WorkflowInstanceWorkflowInstanceState! | Current state of the workflow instance |
context
WorkflowInstanceContext | Optional context for the workflow instance |
lastEvaluatedAt
Time | Timestamp when the workflow was last evaluated |
definitionSnapshot
WorkflowDefinitionDocument | Copy of definition JSON used for this instance |
currentActionIndex
Int! | Index of the current action being executed (used for recovery and resumption) |
controlID
ID | ID of the control this workflow instance is associated with |
internalPolicyID
ID | ID of the internal policy this workflow instance is associated with |
evidenceID
ID | ID of the evidence this workflow instance is associated with |
subcontrolID
ID | ID of the subcontrol this workflow instance is associated with |
actionPlanID
ID | ID of the actionplan this workflow instance is associated with |
procedureID
ID | ID of the procedure this workflow instance is associated with |
campaignID
ID | ID of the campaign this workflow instance is associated with |
campaignTargetID
ID | ID of the campaign target this workflow instance is associated with |
identityHolderID
ID | ID of the identity holder this workflow instance is associated with |
platformID
ID | ID of the platform this workflow instance is associated with |
owner
Organization | |
workflowDefinition
WorkflowDefinition! | Definition driving this instance |
control
Control | Control this workflow instance is associated with |
internalPolicy
InternalPolicy | Internal policy this workflow instance is associated with |
evidence
Evidence | Evidence this workflow instance is associated with |
subcontrol
Subcontrol | Subcontrol this workflow instance is associated with |
actionPlan
ActionPlan | ActionPlan this workflow instance is associated with |
procedure
Procedure | Procedure this workflow instance is associated with |
campaign
Campaign | Campaign this workflow instance is associated with |
campaignTarget
CampaignTarget | Campaign target this workflow instance is associated with |
identityHolder
IdentityHolder | Identity holder this workflow instance is associated with |
platform
Platform | Platform this workflow instance is associated with |
workflowAssignments
WorkflowAssignmentConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowAssignmentOrder!] | Ordering options for WorkflowAssignments returned from the connection. | where
WorkflowAssignmentWhereInput | Filtering options for WorkflowAssignments returned from the connection. |
|
workflowEvents
WorkflowEventConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowEventOrder!] | Ordering options for WorkflowEvents returned from the connection. | where
WorkflowEventWhereInput | Filtering options for WorkflowEvents returned from the connection. |
|
emailTemplates
EmailTemplateConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[EmailTemplateOrder!] | Ordering options for EmailTemplates returned from the connection. | where
EmailTemplateWhereInput | Filtering options for EmailTemplates returned from the connection. |
|
workflowObjectRefs
WorkflowObjectRefConnection! | Arguments | Name | Description |
|---|
after
Cursor | Returns the elements in the list that come after the specified cursor. | first
Int | Returns the first n elements from the list. | before
Cursor | Returns the elements in the list that come before the specified cursor. | last
Int | Returns the last n elements from the list. | orderBy
[WorkflowObjectRefOrder!] | Ordering options for WorkflowObjectRefs returned from the connection. | where
WorkflowObjectRefWhereInput | Filtering options for WorkflowObjectRefs returned from the connection. |
|
proposalPreview
WorkflowProposalPreview | Precomputed proposal preview (diff + values) for approval workflows.
Only available to editors/owners of the target object. |
WorkflowInstanceAdminPayload
Return response for workflow instance admin operations
Fields
WorkflowInstanceBulkAdminPayload
Return response for bulk workflow instance admin operations
Fields
| Name | Description |
|---|
updatedIDs
[ID!]! | IDs of workflow instances updated |
WorkflowInstanceConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[WorkflowInstanceEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
WorkflowInstanceEdge
An edge in a connection.
Fields
Workflow metadata including supported object types and their fields
Fields
WorkflowObjectRef
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
displayID
String! | a shortened prefixed id field to use as a human readable identifier |
ownerID
ID | the ID of the organization owner of the object |
workflowInstanceID
ID! | Workflow instance this object is associated with |
controlID
ID | Control referenced by this workflow instance |
taskID
ID | Task referenced by this workflow instance |
internalPolicyID
ID | Policy referenced by this workflow instance |
findingID
ID | Finding referenced by this workflow instance |
directoryAccountID
ID | Directory account referenced by this workflow instance |
directoryGroupID
ID | Directory group referenced by this workflow instance |
directoryMembershipID
ID | Directory membership referenced by this workflow instance |
evidenceID
ID | Evidence referenced by this workflow instance |
subcontrolID
ID | Subcontrol referenced by this workflow instance |
actionPlanID
ID | ActionPlan referenced by this workflow instance |
procedureID
ID | Procedure referenced by this workflow instance |
campaignID
ID | Campaign referenced by this workflow instance |
campaignTargetID
ID | Campaign target referenced by this workflow instance |
identityHolderID
ID | Identity holder referenced by this workflow instance |
platformID
ID | Platform referenced by this workflow instance |
owner
Organization | |
workflowInstance
WorkflowInstance! | Workflow instance this object is associated with |
control
Control | Control referenced by this workflow instance |
task
Task | Task referenced by this workflow instance |
internalPolicy
InternalPolicy | Policy referenced by this workflow instance |
finding
Finding | Finding referenced by this workflow instance |
directoryAccount
DirectoryAccount | Directory account referenced by this workflow instance |
directoryGroup
DirectoryGroup | Directory group referenced by this workflow instance |
directoryMembership
DirectoryMembership | Directory membership referenced by this workflow instance |
evidence
Evidence | Evidence referenced by this workflow instance |
subcontrol
Subcontrol | Subcontrol referenced by this workflow instance |
actionPlan
ActionPlan | ActionPlan referenced by this workflow instance |
procedure
Procedure | Procedure referenced by this workflow instance |
campaign
Campaign | Campaign referenced by this workflow instance |
campaignTarget
CampaignTarget | Campaign target referenced by this workflow instance |
identityHolder
IdentityHolder | Identity holder referenced by this workflow instance |
platform
Platform | Platform referenced by this workflow instance |
WorkflowObjectRefConnection
A connection to a list of items.
Fields
| Name | Description |
|---|
edges
[WorkflowObjectRefEdge] | A list of edges. |
pageInfo
PageInfo! | Information to aid in pagination. |
totalCount
Int! | Identifies the total count of items in the connection. |
WorkflowObjectRefEdge
An edge in a connection.
Fields
Metadata for a workflow object type
Fields
| Name | Description |
|---|
type
String! | The object type name (e.g., CONTROL, EVIDENCE, POLICY) |
label
String! | Human-readable label for the type |
description
String! | Description of the object type |
eligibleFields
[WorkflowFieldMetadata!]! | List of fields that can be tracked in workflows for this type |
eligibleEdges
[String!]! | List of edges that can be tracked in workflows for this type |
resolverKeys
[String!]! | Available resolver keys for this object type |
WorkflowProposal
Implements
Fields
| Name | Description |
|---|
id
ID! | |
createdAt
Time | |
updatedAt
Time | |
createdBy
String | |
updatedBy
String | |
tags
[String!] | tags associated with the object |
ownerID
ID | the ID of the organization owner of the object |
workflowObjectRefID
ID! | WorkflowObjectRef record that identifies the target object for this proposal |
domainKey
String! | Stable key representing the approval domain for this proposal |
state
WorkflowProposalWorkflowProposalState! | Current state of the proposal |
revision
Int! | Monotonic revision counter; incremented on edits |
changes
Map | Staged field updates for this domain; applied only after approval |
proposedHash
String | Hash of the current proposed changes for approval verification |
approvedHash
String | Hash of the proposed changes that satisfied approvals (what was approved) |
submittedAt
Time | Timestamp when this proposal was submitted for approval |
submittedByUserID
ID | User who submitted this proposal for approval |
owner
Organization | |
preview
WorkflowProposalPreview | Precomputed proposal preview (diff + values) for approval workflows.
Only available to editors/owners of the target object. |
WorkflowProposalPreview
WorkflowProposalPreview describes the proposed changes alongside current values and diffs.
Fields
| Name | Description |
|---|
proposalID
ID! | ID of the workflow proposal |
domainKey
String! | Stable key representing the approval domain for this proposal |
state
WorkflowProposalState! | Current state of the proposal |
submittedAt
DateTime | Timestamp when the proposal was submitted |
submittedByUserID
ID | User who submitted the proposal |
proposedChanges
Map | Proposed changes for the approval domain |
currentValues
Map | Current values for the proposed fields |
diffs
[WorkflowFieldDiff!]! | Field-level diffs for the proposed changes |
WorkflowProposalSubmitPayload
Return response for submitWorkflowProposal mutation
Fields
WorkflowProposalUpdatePayload
Return response for updateWorkflowProposalChanges mutation
Fields
WorkflowProposalWithdrawPayload
Return response for withdrawWorkflowProposal mutation
Fields