Skip to main content

Objects

ActionPlan

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

name
String!

the name of the action plan

description
String

description of the action plan

status
String

status of the action plan

dueDate
Time

due date of the action plan

priority
String

priority of the action plan

source
String

source of the action plan

details
Map

json data including details of the action plan

standard
[Standard!]

risk
[Risk!]

control
[Control!]

user
[User!]

program
[Program!]

ActionPlanBulkCreatePayload

Return response for createBulkActionPlan mutation

Fields

NameDescription

actionPlans
[ActionPlan!]

Created actionPlans

ActionPlanConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

actionPlan
ActionPlan!

Created actionPlan

ActionPlanDeletePayload

Return response for deleteActionPlan mutation

Fields

NameDescription

deletedID
ID!

Deleted actionPlan ID

ActionPlanEdge

An edge in a connection.

Fields

NameDescription

node
ActionPlan

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ActionPlanHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ActionPlanHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

name
String!

the name of the action plan

description
String

description of the action plan

status
String

status of the action plan

dueDate
Time

due date of the action plan

priority
String

priority of the action plan

source
String

source of the action plan

details
Map

json data including details of the action plan

ActionPlanHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ActionPlanHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ActionPlanHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ActionPlanHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ActionPlanSearchResult

Fields

NameDescription

actionPlans
[ActionPlan!]

ActionPlanUpdatePayload

Return response for updateActionPlan mutation

Fields

NameDescription

actionPlan
ActionPlan!

Updated actionPlan

APIToken

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
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

owner
Organization

APITokenBulkCreatePayload

Return response for createBulkAPIToken mutation

Fields

NameDescription

apiTokens
[APIToken!]

Created apiTokens

APITokenConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

apiToken
APIToken!

Created apiToken

APITokenDeletePayload

Return response for deleteAPIToken mutation

Fields

NameDescription

deletedID
ID!

Deleted apiToken ID

APITokenEdge

An edge in a connection.

Fields

NameDescription

node
APIToken

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

APITokenSearchResult

Fields

NameDescription

apiTokens
[APIToken!]

APITokenUpdatePayload

Return response for updateAPIToken mutation

Fields

NameDescription

apiToken
APIToken!

Updated apiToken

AuditLog

Implements

Fields

NameDescription

table
String

time
Time

id
ID!

operation
String

changes
[String!]

updatedBy
ID

AuditLogConnection

A connection to a list of items.

Fields

NameDescription

edges
[AuditLogEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

AuditLogEdge

An edge in a connection.

Fields

NameDescription

node
AuditLog

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

Contact

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
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
[Entity!]

files
[File!]

ContactBulkCreatePayload

Return response for createBulkContact mutation

Fields

NameDescription

contacts
[Contact!]

Created contacts

ContactConnection

A connection to a list of items.

Fields

NameDescription

edges
[ContactEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ContactCreatePayload

Return response for createContact mutation

Fields

NameDescription

contact
Contact!

Created contact

ContactDeletePayload

Return response for deleteContact mutation

Fields

NameDescription

deletedID
ID!

Deleted contact ID

ContactEdge

An edge in a connection.

Fields

NameDescription

node
Contact

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ContactHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ContactHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

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
ContactHistoryUserStatus!

status of the contact

ContactHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ContactHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ContactHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ContactHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ContactSearchResult

Fields

NameDescription

contacts
[Contact!]

ContactUpdatePayload

Return response for updateContact mutation

Fields

NameDescription

contact
Contact!

Updated contact

Control

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID!

the ID of the organization owner of the object

name
String!

the name of the control

description
String

description of the control

status
String

status of the control

controlType
String

type of the control

version
String

version of the control

controlNumber
String

control number or identifier

family
String

family associated with the control

class
String

class associated with the control

source
String

source of the control, e.g. framework, template, custom, etc.

satisfies
String

which control objectives are satisfied by the control

mappedFrameworks
String

mapped frameworks

details
Map

json data including details of the control

owner
Organization!

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

viewers
[Group!]

provides view access to the risk to members of the group

procedures
[Procedure!]

subcontrols
[Subcontrol!]

controlObjectives
[ControlObjective!]

standard
[Standard!]

narratives
[Narrative!]

risks
[Risk!]

actionPlans
[ActionPlan!]

tasks
[Task!]

programs
[Program!]

ControlBulkCreatePayload

Return response for createBulkControl mutation

Fields

NameDescription

controls
[Control!]

Created controls

ControlConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

control
Control!

Created control

ControlDeletePayload

Return response for deleteControl mutation

Fields

NameDescription

deletedID
ID!

Deleted control ID

ControlEdge

An edge in a connection.

Fields

NameDescription

node
Control

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ControlHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ControlHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String!

the ID of the organization owner of the object

name
String!

the name of the control

description
String

description of the control

status
String

status of the control

controlType
String

type of the control

version
String

version of the control

controlNumber
String

control number or identifier

family
String

family associated with the control

class
String

class associated with the control

source
String

source of the control, e.g. framework, template, custom, etc.

satisfies
String

which control objectives are satisfied by the control

mappedFrameworks
String

mapped frameworks

details
Map

json data including details of the control

ControlHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ControlHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ControlHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ControlHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ControlObjective

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID!

the ID of the organization owner of the object

name
String!

the name of the control objective

description
String

description of the control objective

status
String

status of the control objective

controlObjectiveType
String

type of the control objective

version
String

version of the control objective

controlNumber
String

number of the control objective

family
String

family of the control objective

class
String

class associated with the control objective

source
String

source of the control objective, e.g. framework, template, user-defined, etc.

mappedFrameworks
String

mapped frameworks

details
Map

json data including details of the control objective

owner
Organization!

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

viewers
[Group!]

provides view access to the risk to members of the group

internalPolicies
[InternalPolicy!]

controls
[Control!]

procedures
[Procedure!]

risks
[Risk!]

subcontrols
[Subcontrol!]

standard
[Standard!]

narratives
[Narrative!]

tasks
[Task!]

programs
[Program!]

ControlObjectiveBulkCreatePayload

Return response for createBulkControlObjective mutation

Fields

NameDescription

controlObjectives
[ControlObjective!]

Created controlObjectives

ControlObjectiveConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

controlObjective
ControlObjective!

Created controlObjective

ControlObjectiveDeletePayload

Return response for deleteControlObjective mutation

Fields

NameDescription

deletedID
ID!

Deleted controlObjective ID

ControlObjectiveEdge

An edge in a connection.

Fields

NameDescription

node
ControlObjective

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ControlObjectiveHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ControlObjectiveHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String!

the ID of the organization owner of the object

name
String!

the name of the control objective

description
String

description of the control objective

status
String

status of the control objective

controlObjectiveType
String

type of the control objective

version
String

version of the control objective

controlNumber
String

number of the control objective

family
String

family of the control objective

class
String

class associated with the control objective

source
String

source of the control objective, e.g. framework, template, user-defined, etc.

mappedFrameworks
String

mapped frameworks

details
Map

json data including details of the control objective

ControlObjectiveHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ControlObjectiveHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ControlObjectiveHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ControlObjectiveHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ControlObjectiveSearchResult

Fields

NameDescription

controlObjectives
[ControlObjective!]

ControlObjectiveUpdatePayload

Return response for updateControlObjective mutation

Fields

NameDescription

controlObjective
ControlObjective!

Updated controlObjective

ControlSearchResult

Fields

NameDescription

controls
[Control!]

ControlUpdatePayload

Return response for updateControl mutation

Fields

NameDescription

control
Control!

Updated control

DocumentData

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
ID

the organization id that owns the object

templateID
ID!

the template id of the document

data
JSON!

the json data of the document

owner
Organization

template
Template!

entity
[Entity!]

files
[File!]

DocumentDataBulkCreatePayload

Return response for createBulkDocumentData mutation

Fields

NameDescription

documentData
[DocumentData!]

Created documentData

DocumentDataConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

documentData
DocumentData!

Created documentData

DocumentDataDeletePayload

Return response for deleteDocumentData mutation

Fields

NameDescription

deletedID
ID!

Deleted documentData ID

DocumentDataEdge

An edge in a connection.

Fields

NameDescription

node
DocumentData

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

DocumentDataHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
DocumentDataHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
String

the organization id that owns the object

templateID
String!

the template id of the document

data
JSON!

the json data of the document

DocumentDataHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[DocumentDataHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

DocumentDataHistoryEdge

An edge in a connection.

Fields

NameDescription

node
DocumentDataHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

DocumentDataSearchResult

Fields

NameDescription

documentData
[DocumentData!]

DocumentDataUpdatePayload

Return response for updateDocumentData mutation

Fields

NameDescription

documentData
DocumentData!

Updated documentData

Entity

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

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
String

status of the entity

owner
Organization

contacts
[Contact!]

documents
[DocumentData!]

notes
[Note!]

files
[File!]

entityType
EntityType

EntityBulkCreatePayload

Return response for createBulkEntity mutation

Fields

NameDescription

entities
[Entity!]

Created entities

EntityConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

entity
Entity!

Created entity

EntityDeletePayload

Return response for deleteEntity mutation

Fields

NameDescription

deletedID
ID!

Deleted entity ID

EntityEdge

An edge in a connection.

Fields

NameDescription

node
Entity

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EntityHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
EntityHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

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
String

The type of the entity

status
String

status of the entity

EntityHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[EntityHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EntityHistoryEdge

An edge in a connection.

Fields

NameDescription

node
EntityHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EntitySearchResult

Fields

NameDescription

entities
[Entity!]

EntityType

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

name
String!

the name of the entity

owner
Organization

entities
[Entity!]

EntityTypeBulkCreatePayload

Return response for createBulkEntityType mutation

Fields

NameDescription

entityTypes
[EntityType!]

Created entityTypes

EntityTypeConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

entityType
EntityType!

Created entityType

EntityTypeDeletePayload

Return response for deleteEntityType mutation

Fields

NameDescription

deletedID
ID!

Deleted entityType ID

EntityTypeEdge

An edge in a connection.

Fields

NameDescription

node
EntityType

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EntityTypeHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
EntityTypeHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

name
String!

the name of the entity

EntityTypeHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[EntityTypeHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EntityTypeHistoryEdge

An edge in a connection.

Fields

NameDescription

node
EntityTypeHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EntityTypeSearchResult

Fields

NameDescription

entityTypes
[EntityType!]

EntityTypeUpdatePayload

Return response for updateEntityType mutation

Fields

NameDescription

entityType
EntityType!

Updated entityType

EntityUpdatePayload

Return response for updateEntity mutation

Fields

NameDescription

entity
Entity!

Updated entity

Event

Implements

Fields

NameDescription

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

user
[User!]

group
[Group!]

integration
[Integration!]

organization
[Organization!]

invite
[Invite!]

personalAccessToken
[PersonalAccessToken!]

hush
[Hush!]

orgmembership
[OrgMembership!]

groupmembership
[GroupMembership!]

subscriber
[Subscriber!]

file
[File!]

EventBulkCreatePayload

Return response for createBulkEvent mutation

Fields

NameDescription

events
[Event!]

Created events

EventConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

event
Event!

Created event

EventDeletePayload

Return response for deleteEvent mutation

Fields

NameDescription

deletedID
ID!

Deleted event ID

EventEdge

An edge in a connection.

Fields

NameDescription

node
Event

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EventHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
EventHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

eventID
String

correlationID
String

eventType
String!

metadata
Map

EventHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[EventHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

EventHistoryEdge

An edge in a connection.

Fields

NameDescription

node
EventHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

EventSearchResult

Fields

NameDescription

events
[Event!]

EventUpdatePayload

Return response for updateEvent mutation

Fields

NameDescription

event
Event!

Updated event

File

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

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

user
[User!]

organization
[Organization!]

group
[Group!]

contact
[Contact!]

entity
[Entity!]

userSetting
[UserSetting!]

organizationSetting
[OrganizationSetting!]

template
[Template!]

documentData
[DocumentData!]

events
[Event!]

program
[Program!]

FileConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

deletedID
ID!

Deleted file ID

FileEdge

An edge in a connection.

Fields

NameDescription

node
File

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

FileHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
FileHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

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

FileHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[FileHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

FileHistoryEdge

An edge in a connection.

Fields

NameDescription

node
FileHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

FileSearchResult

Fields

NameDescription

files
[File!]

Group

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

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

displayName
String!

The group's displayed 'friendly' name

owner
Organization

controlCreators
[Organization!]

controlObjectiveCreators
[Organization!]

groupCreators
[Organization!]

internalPolicyCreators
[Organization!]

narrativeCreators
[Organization!]

procedureCreators
[Organization!]

programCreators
[Organization!]

riskCreators
[Organization!]

templateCreators
[Organization!]

procedureEditors
[Procedure!]

procedureBlockedGroups
[Procedure!]

internalPolicyEditors
[InternalPolicy!]

internalPolicyBlockedGroups
[InternalPolicy!]

programEditors
[Program!]

programBlockedGroups
[Program!]

programViewers
[Program!]

riskEditors
[Risk!]

riskBlockedGroups
[Risk!]

riskViewers
[Risk!]

controlObjectiveEditors
[ControlObjective!]

controlObjectiveBlockedGroups
[ControlObjective!]

controlObjectiveViewers
[ControlObjective!]

controlEditors
[Control!]

controlBlockedGroups
[Control!]

controlViewers
[Control!]

narrativeEditors
[Narrative!]

narrativeBlockedGroups
[Narrative!]

narrativeViewers
[Narrative!]

setting
GroupSetting!

users
[User!]

events
[Event!]

integrations
[Integration!]

files
[File!]

tasks
[Task!]

members
[GroupMembership!]

GroupBulkCreatePayload

Return response for createBulkGroup mutation

Fields

NameDescription

groups
[Group!]

Created groups

GroupConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

group
Group!

Created group

GroupDeletePayload

Return response for deleteGroup mutation

Fields

NameDescription

deletedID
ID!

Deleted group ID

GroupEdge

An edge in a connection.

Fields

NameDescription

node
Group

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
GroupHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

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

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

displayName
String!

The group's displayed 'friendly' name

GroupHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[GroupHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GroupHistoryEdge

An edge in a connection.

Fields

NameDescription

node
GroupHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupMembership

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
GroupMembershipRole!

groupID
ID!

userID
ID!

group
Group!

user
User!

events
[Event!]

GroupMembershipBulkCreatePayload

Return response for createBulkGroupMembership mutation

Fields

NameDescription

groupMemberships
[GroupMembership!]

Created groupMemberships

GroupMembershipConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

groupMembership
GroupMembership!

Created groupMembership

GroupMembershipDeletePayload

Return response for deleteGroupMembership mutation

Fields

NameDescription

deletedID
ID!

Deleted groupMembership ID

GroupMembershipEdge

An edge in a connection.

Fields

NameDescription

node
GroupMembership

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupMembershipHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
GroupMembershipHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
GroupMembershipHistoryRole!

groupID
String!

userID
String!

GroupMembershipHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[GroupMembershipHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GroupMembershipHistoryEdge

An edge in a connection.

Fields

NameDescription

node
GroupMembershipHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupMembershipUpdatePayload

Return response for updateGroupMembership mutation

Fields

NameDescription

groupMembership
GroupMembership!

Updated groupMembership

GroupSearchResult

Fields

NameDescription

groups
[Group!]

GroupSetting

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
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

NameDescription

groupSettings
[GroupSetting!]

Created groupSettings

GroupSettingConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

groupSetting
GroupSetting!

Created groupSetting

GroupSettingDeletePayload

Return response for deleteGroupSetting mutation

Fields

NameDescription

deletedID
ID!

Deleted groupSetting ID

GroupSettingEdge

An edge in a connection.

Fields

NameDescription

node
GroupSetting

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupSettingHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
GroupSettingHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

visibility
GroupSettingHistoryVisibility!

whether the group is visible to it's members / owners only or if it's searchable by anyone within the organization

joinPolicy
GroupSettingHistoryJoinPolicy!

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
String

the group id associated with the settings

GroupSettingHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[GroupSettingHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

GroupSettingHistoryEdge

An edge in a connection.

Fields

NameDescription

node
GroupSettingHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

GroupSettingSearchResult

Fields

NameDescription

groupSettings
[GroupSetting!]

GroupSettingUpdatePayload

Return response for updateGroupSetting mutation

Fields

NameDescription

groupSetting
GroupSetting!

Updated groupSetting

GroupUpdatePayload

Return response for updateGroup mutation

Fields

NameDescription

group
Group!

Updated group

Hush

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

integrations
[Integration!]

the integration associated with the secret

organization
[Organization!]

events
[Event!]

HushBulkCreatePayload

Return response for createBulkHush mutation

Fields

NameDescription

hushes
[Hush!]

Created hushs

HushConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

hush
Hush!

Created hush

HushDeletePayload

Return response for deleteHush mutation

Fields

NameDescription

deletedID
ID!

Deleted hush ID

HushEdge

An edge in a connection.

Fields

NameDescription

node
Hush

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

HushHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
HushHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

HushHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[HushHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

HushHistoryEdge

An edge in a connection.

Fields

NameDescription

node
HushHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

HushUpdatePayload

Return response for updateHush mutation

Fields

NameDescription

hush
Hush!

Updated hush

Integration

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
ID

the organization id that owns the object

name
String!

the name of the integration - must be unique within the organization

description
String

a description of the integration

kind
String

owner
Organization

secrets
[Hush!]

the secrets associated with the integration

events
[Event!]

IntegrationBulkCreatePayload

Return response for createBulkIntegration mutation

Fields

NameDescription

integrations
[Integration!]

Created integrations

IntegrationConnection

A connection to a list of items.

Fields

NameDescription

edges
[IntegrationEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IntegrationCreatePayload

Return response for createIntegration mutation

Fields

NameDescription

integration
Integration!

Created integration

IntegrationDeletePayload

Return response for deleteIntegration mutation

Fields

NameDescription

deletedID
ID!

Deleted integration ID

IntegrationEdge

An edge in a connection.

Fields

NameDescription

node
Integration

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

IntegrationHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
IntegrationHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
String

the organization id that owns the object

name
String!

the name of the integration - must be unique within the organization

description
String

a description of the integration

kind
String

IntegrationHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[IntegrationHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

IntegrationHistoryEdge

An edge in a connection.

Fields

NameDescription

node
IntegrationHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

IntegrationSearchResult

Fields

NameDescription

integrations
[Integration!]

IntegrationUpdatePayload

Return response for updateIntegration mutation

Fields

NameDescription

integration
Integration!

Updated integration

InternalPolicy

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

name
String!

the name of the policy

description
String

description of the policy

status
String

status of the policy

policyType
String

type of the policy

version
String

version of the policy

purposeAndScope
String

purpose and scope

background
String

background of the policy

details
Map

json data for the policy document

owner
Organization

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

controlObjectives
[ControlObjective!]

controls
[Control!]

procedures
[Procedure!]

narratives
[Narrative!]

tasks
[Task!]

programs
[Program!]

InternalPolicyBulkCreatePayload

Return response for createBulkInternalPolicy mutation

Fields

NameDescription

internalPolicies
[InternalPolicy!]

Created internalPolicys

InternalPolicyConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

internalPolicy
InternalPolicy!

Created internalPolicy

InternalPolicyDeletePayload

Return response for deleteInternalPolicy mutation

Fields

NameDescription

deletedID
ID!

Deleted internalPolicy ID

InternalPolicyEdge

An edge in a connection.

Fields

NameDescription

node
InternalPolicy

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

InternalPolicyHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
InternalPolicyHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

name
String!

the name of the policy

description
String

description of the policy

status
String

status of the policy

policyType
String

type of the policy

version
String

version of the policy

purposeAndScope
String

purpose and scope

background
String

background of the policy

details
Map

json data for the policy document

InternalPolicyHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[InternalPolicyHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

InternalPolicyHistoryEdge

An edge in a connection.

Fields

NameDescription

node
InternalPolicyHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

InternalPolicySearchResult

Fields

NameDescription

internalPolicies
[InternalPolicy!]

InternalPolicyUpdatePayload

Return response for updateInternalPolicy mutation

Fields

NameDescription

internalPolicy
InternalPolicy!

Updated internalPolicy

Invite

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

requestorID
String

the user who initiated the invitation

owner
Organization

events
[Event!]

InviteBulkCreatePayload

Return response for createBulkInvite mutation

Fields

NameDescription

invites
[Invite!]

Created invites

InviteConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

invite
Invite!

Created invite

InviteDeletePayload

Return response for deleteInvite mutation

Fields

NameDescription

deletedID
ID!

Deleted invite ID

InviteEdge

An edge in a connection.

Fields

NameDescription

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

NameDescription

invite
Invite!

Updated invite

Narrative

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID!

the ID of the organization owner of the object

name
String!

the name of the narrative

description
String

the description of the narrative

satisfies
String

which controls are satisfied by the narrative

details
Map

json data for the narrative document

owner
Organization!

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

viewers
[Group!]

provides view access to the risk to members of the group

internalPolicy
[InternalPolicy!]

control
[Control!]

procedure
[Procedure!]

controlObjective
[ControlObjective!]

programs
[Program!]

NarrativeBulkCreatePayload

Return response for createBulkNarrative mutation

Fields

NameDescription

narratives
[Narrative!]

Created narratives

NarrativeConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

narrative
Narrative!

Created narrative

NarrativeDeletePayload

Return response for deleteNarrative mutation

Fields

NameDescription

deletedID
ID!

Deleted narrative ID

NarrativeEdge

An edge in a connection.

Fields

NameDescription

node
Narrative

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

NarrativeHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
NarrativeHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String!

the ID of the organization owner of the object

name
String!

the name of the narrative

description
String

the description of the narrative

satisfies
String

which controls are satisfied by the narrative

details
Map

json data for the narrative document

NarrativeHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[NarrativeHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

NarrativeHistoryEdge

An edge in a connection.

Fields

NameDescription

node
NarrativeHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

NarrativeSearchResult

Fields

NameDescription

narratives
[Narrative!]

NarrativeUpdatePayload

Return response for updateNarrative mutation

Fields

NameDescription

narrative
Narrative!

Updated narrative

Note

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

text
String!

the text of the note

owner
Organization

entity
Entity

subcontrols
[Subcontrol!]

program
[Program!]

NoteConnection

A connection to a list of items.

Fields

NameDescription

edges
[NoteEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

NoteEdge

An edge in a connection.

Fields

NameDescription

node
Note

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

NoteHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
NoteHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

text
String!

the text of the note

NoteHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[NoteHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

NoteHistoryEdge

An edge in a connection.

Fields

NameDescription

node
NoteHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

Organization

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

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

dedicatedDb
Boolean!

Whether the organization has a dedicated database

controlCreators
[Group!]

groups that are allowed to create controls

controlObjectiveCreators
[Group!]

groups that are allowed to create control_objectives

groupCreators
[Group!]

groups that are allowed to create groups

internalPolicyCreators
[Group!]

groups that are allowed to create internal_policys

narrativeCreators
[Group!]

groups that are allowed to create narratives

procedureCreators
[Group!]

groups that are allowed to create procedures

programCreators
[Group!]

groups that are allowed to create programs

riskCreators
[Group!]

groups that are allowed to create risks

templateCreators
[Group!]

groups that are allowed to create templates

parent
Organization

children
OrganizationConnection!

Arguments

NameDescription

after
Cursor

Returns the elements in the list that come after the specified cursor.

first
Int

Returns the first n elements from the list.

before
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.

groups
[Group!]

templates
[Template!]

integrations
[Integration!]

setting
OrganizationSetting

documentData
[DocumentData!]

orgSubscriptions
[OrgSubscription!]

personalAccessTokens
[PersonalAccessToken!]

apiTokens
[APIToken!]

users
[User!]

invites
[Invite!]

subscribers
[Subscriber!]

events
[Event!]

secrets
[Hush!]

files
[File!]

entities
[Entity!]

entityTypes
[EntityType!]

contacts
[Contact!]

notes
[Note!]

tasks
[Task!]

programs
[Program!]

procedures
[Procedure!]

internalPolicies
[InternalPolicy!]

risks
[Risk!]

controlObjectives
[ControlObjective!]

narratives
[Narrative!]

controls
[Control!]

subcontrols
[Subcontrol!]

members
[OrgMembership!]

OrganizationBulkCreatePayload

Return response for createBulkOrganization mutation

Fields

NameDescription

organizations
[Organization!]

Created organizations

OrganizationConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

organization
Organization!

Created organization

OrganizationDeletePayload

Return response for deleteOrganization mutation

Fields

NameDescription

deletedID
ID!

Deleted organization ID

OrganizationEdge

An edge in a connection.

Fields

NameDescription

node
Organization

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrganizationHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
OrganizationHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

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

dedicatedDb
Boolean!

Whether the organization has a dedicated database

OrganizationHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrganizationHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationHistoryEdge

An edge in a connection.

Fields

NameDescription

node
OrganizationHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrganizationSearchResult

Fields

NameDescription

organizations
[Organization!]

OrganizationSetting

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

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
String

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

stripeID
String

the ID of the stripe customer associated with the organization

organization
Organization

files
[File!]

OrganizationSettingBulkCreatePayload

Return response for createBulkOrganizationSetting mutation

Fields

NameDescription

organizationSettings
[OrganizationSetting!]

Created organizationSettings

OrganizationSettingConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrganizationSettingEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationSettingCreatePayload

Return response for createOrganizationSetting mutation

Fields

NameDescription

organizationSetting
OrganizationSetting!

Created organizationSetting

OrganizationSettingDeletePayload

Return response for deleteOrganizationSetting mutation

Fields

NameDescription

deletedID
ID!

Deleted organizationSetting ID

OrganizationSettingEdge

An edge in a connection.

Fields

NameDescription

node
OrganizationSetting

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrganizationSettingHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
OrganizationSettingHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

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
String

Address to send billing information to

taxIdentifier
String

Usually government-issued tax ID or business ID such as ABN in Australia

geoLocation
OrganizationSettingHistoryRegion

geographical location of the organization

organizationID
String

the ID of the organization the settings belong to

stripeID
String

the ID of the stripe customer associated with the organization

OrganizationSettingHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrganizationSettingHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrganizationSettingHistoryEdge

An edge in a connection.

Fields

NameDescription

node
OrganizationSettingHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrganizationSettingSearchResult

Fields

NameDescription

organizationSettings
[OrganizationSetting!]

OrganizationSettingUpdatePayload

Return response for updateOrganizationSetting mutation

Fields

NameDescription

organizationSetting
OrganizationSetting!

Updated organizationSetting

OrganizationUpdatePayload

Return response for updateOrganization mutation

Fields

NameDescription

organization
Organization!

Updated organization

OrgMembership

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
OrgMembershipRole!

organizationID
ID!

userID
ID!

organization
Organization!

user
User!

events
[Event!]

OrgMembershipBulkCreatePayload

Return response for createBulkOrgMembership mutation

Fields

NameDescription

orgMemberships
[OrgMembership!]

Created orgMemberships

OrgMembershipConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

orgMembership
OrgMembership!

Created orgMembership

OrgMembershipDeletePayload

Return response for deleteOrgMembership mutation

Fields

NameDescription

deletedID
ID!

Deleted orgMembership ID

OrgMembershipEdge

An edge in a connection.

Fields

NameDescription

node
OrgMembership

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrgMembershipHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
OrgMembershipHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
OrgMembershipHistoryRole!

organizationID
String!

userID
String!

OrgMembershipHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrgMembershipHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrgMembershipHistoryEdge

An edge in a connection.

Fields

NameDescription

node
OrgMembershipHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrgMembershipUpdatePayload

Return response for updateOrgMembership mutation

Fields

NameDescription

orgMembership
OrgMembership!

Updated orgMembership

OrgSubscription

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
ID

the organization id that owns the object

stripeSubscriptionID
String

the stripe subscription id

productTier
String

the common name of the product tier the subscription is associated with, e.g. starter tier

stripeProductTierID
String

the product id that represents the tier in stripe

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

stripeCustomerID
String

the customer ID the subscription is associated to

expiresAt
Time

the time the subscription is set to expire; only populated if subscription is cancelled

features
[String!]

the features associated with the subscription

owner
Organization

OrgSubscriptionBulkCreatePayload

Return response for createBulkOrgSubscription mutation

Fields

NameDescription

orgSubscriptions
[OrgSubscription!]

Created orgSubscriptions

OrgSubscriptionConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrgSubscriptionEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrgSubscriptionCreatePayload

Return response for createOrgSubscription mutation

Fields

NameDescription

orgSubscription
OrgSubscription!

Created orgSubscription

OrgSubscriptionDeletePayload

Return response for deleteOrgSubscription mutation

Fields

NameDescription

deletedID
ID!

Deleted orgSubscription ID

OrgSubscriptionEdge

An edge in a connection.

Fields

NameDescription

node
OrgSubscription

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrgSubscriptionHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
OrgSubscriptionHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

ownerID
String

the organization id that owns the object

stripeSubscriptionID
String

the stripe subscription id

productTier
String

the common name of the product tier the subscription is associated with, e.g. starter tier

stripeProductTierID
String

the product id that represents the tier in stripe

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

stripeCustomerID
String

the customer ID the subscription is associated to

expiresAt
Time

the time the subscription is set to expire; only populated if subscription is cancelled

features
[String!]

the features associated with the subscription

OrgSubscriptionHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[OrgSubscriptionHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

OrgSubscriptionHistoryEdge

An edge in a connection.

Fields

NameDescription

node
OrgSubscriptionHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

OrgSubscriptionSearchResult

Fields

NameDescription

orgSubscriptions
[OrgSubscription!]

OrgSubscriptionUpdatePayload

Return response for updateOrgSubscription mutation

Fields

NameDescription

orgSubscription
OrgSubscription!

Updated orgSubscription

PageInfo

Information about pagination in a connection. https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo

Fields

NameDescription

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

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
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!]

lastUsedAt
Time

owner
User!

organizations
[Organization!]

the organization(s) the token is associated with

events
[Event!]

PersonalAccessTokenBulkCreatePayload

Return response for createBulkPersonalAccessToken mutation

Fields

NameDescription

personalAccessTokens
[PersonalAccessToken!]

Created personalAccessTokens

PersonalAccessTokenConnection

A connection to a list of items.

Fields

NameDescription

edges
[PersonalAccessTokenEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

PersonalAccessTokenCreatePayload

Return response for createPersonalAccessToken mutation

Fields

NameDescription

personalAccessToken
PersonalAccessToken!

Created personalAccessToken

PersonalAccessTokenDeletePayload

Return response for deletePersonalAccessToken mutation

Fields

NameDescription

deletedID
ID!

Deleted personalAccessToken ID

PersonalAccessTokenEdge

An edge in a connection.

Fields

NameDescription

node
PersonalAccessToken

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

PersonalAccessTokenSearchResult

Fields

NameDescription

personalAccessTokens
[PersonalAccessToken!]

PersonalAccessTokenUpdatePayload

Return response for updatePersonalAccessToken mutation

Fields

NameDescription

personalAccessToken
PersonalAccessToken!

Updated personalAccessToken

Procedure

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

name
String!

the name of the procedure

description
String

description of the procedure

status
String

status of the procedure

procedureType
String

type of the procedure

version
String

version of the procedure

purposeAndScope
String

purpose and scope

background
String

background of the procedure

satisfies
String

which controls are satisfied by the procedure

details
Map

json data for the procedure document

owner
Organization

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

controls
[Control!]

internalPolicies
[InternalPolicy!]

narratives
[Narrative!]

risks
[Risk!]

tasks
[Task!]

programs
[Program!]

ProcedureBulkCreatePayload

Return response for createBulkProcedure mutation

Fields

NameDescription

procedures
[Procedure!]

Created procedures

ProcedureConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

procedure
Procedure!

Created procedure

ProcedureDeletePayload

Return response for deleteProcedure mutation

Fields

NameDescription

deletedID
ID!

Deleted procedure ID

ProcedureEdge

An edge in a connection.

Fields

NameDescription

node
Procedure

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProcedureHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ProcedureHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

name
String!

the name of the procedure

description
String

description of the procedure

status
String

status of the procedure

procedureType
String

type of the procedure

version
String

version of the procedure

purposeAndScope
String

purpose and scope

background
String

background of the procedure

satisfies
String

which controls are satisfied by the procedure

details
Map

json data for the procedure document

ProcedureHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ProcedureHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProcedureHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ProcedureHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProcedureSearchResult

Fields

NameDescription

procedures
[Procedure!]

ProcedureUpdatePayload

Return response for updateProcedure mutation

Fields

NameDescription

procedure
Procedure!

Updated procedure

Program

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

name
String!

the name of the program

description
String

the description of the program

status
ProgramProgramStatus!

the status of the program

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

owner
Organization

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

viewers
[Group!]

provides view access to the risk to members of the group

controls
[Control!]

subcontrols
[Subcontrol!]

controlObjectives
[ControlObjective!]

internalPolicies
[InternalPolicy!]

procedures
[Procedure!]

risks
[Risk!]

tasks
[Task!]

notes
[Note!]

files
[File!]

narratives
[Narrative!]

actionPlans
[ActionPlan!]

standards
[Standard!]

the framework(s) that the program is based on

users
[User!]

members
[ProgramMembership!]

ProgramBulkCreatePayload

Return response for createBulkProgram mutation

Fields

NameDescription

programs
[Program!]

Created programs

ProgramConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

program
Program!

Created program

ProgramDeletePayload

Return response for deleteProgram mutation

Fields

NameDescription

deletedID
ID!

Deleted program ID

ProgramEdge

An edge in a connection.

Fields

NameDescription

node
Program

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProgramHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ProgramHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

name
String!

the name of the program

description
String

the description of the program

status
ProgramHistoryProgramStatus!

the status of the program

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

ProgramHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ProgramHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProgramHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ProgramHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProgramMembership

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
ProgramMembershipRole!

programID
ID!

userID
ID!

program
Program!

user
User!

ProgramMembershipBulkCreatePayload

Return response for createBulkProgramMembership mutation

Fields

NameDescription

programMemberships
[ProgramMembership!]

Created programMemberships

ProgramMembershipConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

programMembership
ProgramMembership!

Created programMembership

ProgramMembershipDeletePayload

Return response for deleteProgramMembership mutation

Fields

NameDescription

deletedID
ID!

Deleted programMembership ID

ProgramMembershipEdge

An edge in a connection.

Fields

NameDescription

node
ProgramMembership

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProgramMembershipHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
ProgramMembershipHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

role
ProgramMembershipHistoryRole!

programID
String!

userID
String!

ProgramMembershipHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[ProgramMembershipHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

ProgramMembershipHistoryEdge

An edge in a connection.

Fields

NameDescription

node
ProgramMembershipHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

ProgramMembershipUpdatePayload

Return response for updateProgramMembership mutation

Fields

NameDescription

programMembership
ProgramMembership!

Updated programMembership

ProgramSearchResult

Fields

NameDescription

programs
[Program!]

ProgramUpdatePayload

Return response for updateProgram mutation

Fields

NameDescription

program
Program!

Updated program

Risk

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID!

the ID of the organization owner of the object

name
String!

the name of the risk

description
String

description of the risk

status
String

status of the risk - mitigated or not, inflight, etc.

riskType
String

type of the risk, e.g. strategic, operational, financial, external, etc.

businessCosts
String

business costs associated with the risk

impact
RiskRiskImpact

impact of the risk - high, medium, low

likelihood
RiskRiskLikelihood

likelihood of the risk occurring; unlikely, likely, highly likely

mitigation
String

mitigation for the risk

satisfies
String

which controls are satisfied by the risk

details
Map

json data for the risk document

owner
Organization!

blockedGroups
[Group!]

groups that are blocked from viewing or editing the risk

editors
[Group!]

provides edit access to the risk to members of the group

viewers
[Group!]

provides view access to the risk to members of the group

control
[Control!]

procedure
[Procedure!]

actionPlans
[ActionPlan!]

programs
[Program!]

RiskBulkCreatePayload

Return response for createBulkRisk mutation

Fields

NameDescription

risks
[Risk!]

Created risks

RiskConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

risk
Risk!

Created risk

RiskDeletePayload

Return response for deleteRisk mutation

Fields

NameDescription

deletedID
ID!

Deleted risk ID

RiskEdge

An edge in a connection.

Fields

NameDescription

node
Risk

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

RiskHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
RiskHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String!

the ID of the organization owner of the object

name
String!

the name of the risk

description
String

description of the risk

status
String

status of the risk - mitigated or not, inflight, etc.

riskType
String

type of the risk, e.g. strategic, operational, financial, external, etc.

businessCosts
String

business costs associated with the risk

impact
RiskHistoryRiskImpact

impact of the risk - high, medium, low

likelihood
RiskHistoryRiskLikelihood

likelihood of the risk occurring; unlikely, likely, highly likely

mitigation
String

mitigation for the risk

satisfies
String

which controls are satisfied by the risk

details
Map

json data for the risk document

RiskHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[RiskHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

RiskHistoryEdge

An edge in a connection.

Fields

NameDescription

node
RiskHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

RiskSearchResult

Fields

NameDescription

risks
[Risk!]

RiskUpdatePayload

Return response for updateRisk mutation

Fields

NameDescription

risk
Risk!

Updated risk

SearchResultConnection

Fields

NameDescription

page
PageInfo!

nodes
[SearchResult!]!

Standard

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

name
String!

the name of the standard body, e.g. TSC, NIST, SOC, HITRUST, FedRamp, etc.

description
String

description of the standard

family
String

family of the standard, e.g. 800-53, 800-171, 27001, etc.

status
String

status of the standard - active, deprecated, etc.

standardType
String

type of the standard - security, privacy, etc.

version
String

version of the standard

purposeAndScope
String

purpose and scope

background
String

background of the standard

satisfies
String

which controls are satisfied by the standard

details
Map

json data with details of the standard

controlObjectives
[ControlObjective!]

controls
[Control!]

procedures
[Procedure!]

actionPlans
[ActionPlan!]

programs
[Program!]

StandardBulkCreatePayload

Return response for createBulkStandard mutation

Fields

NameDescription

standards
[Standard!]

Created standards

StandardConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

standard
Standard!

Created standard

StandardDeletePayload

Return response for deleteStandard mutation

Fields

NameDescription

deletedID
ID!

Deleted standard ID

StandardEdge

An edge in a connection.

Fields

NameDescription

node
Standard

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

StandardHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
StandardHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

name
String!

the name of the standard body, e.g. TSC, NIST, SOC, HITRUST, FedRamp, etc.

description
String

description of the standard

family
String

family of the standard, e.g. 800-53, 800-171, 27001, etc.

status
String

status of the standard - active, deprecated, etc.

standardType
String

type of the standard - security, privacy, etc.

version
String

version of the standard

purposeAndScope
String

purpose and scope

background
String

background of the standard

satisfies
String

which controls are satisfied by the standard

details
Map

json data with details of the standard

StandardHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[StandardHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

StandardHistoryEdge

An edge in a connection.

Fields

NameDescription

node
StandardHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

StandardSearchResult

Fields

NameDescription

standards
[Standard!]

StandardUpdatePayload

Return response for updateStandard mutation

Fields

NameDescription

standard
Standard!

Updated standard

Subcontrol

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID!

the ID of the organization owner of the object

name
String!

the name of the subcontrol

description
String

description of the subcontrol

status
String

status of the subcontrol

subcontrolType
String

type of the subcontrol

version
String

version of the control

subcontrolNumber
String

number of the subcontrol

family
String

subcontrol family

class
String

subcontrol class

source
String

source of the control, e.g. framework, template, user-defined, etc.

mappedFrameworks
String

mapped frameworks that the subcontrol is part of

implementationEvidence
String

implementation evidence of the subcontrol

implementationStatus
String

implementation status

implementationDate
Time

date the subcontrol was implemented

implementationVerification
String

implementation verification

implementationVerificationDate
Time

date the subcontrol implementation was verified

details
Map

json data details of the subcontrol

owner
Organization!

controls
[Control!]!

user
[User!]

tasks
[Task!]

notes
Note

programs
[Program!]

SubcontrolBulkCreatePayload

Return response for createBulkSubcontrol mutation

Fields

NameDescription

subcontrols
[Subcontrol!]

Created subcontrols

SubcontrolConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

subcontrol
Subcontrol!

Created subcontrol

SubcontrolDeletePayload

Return response for deleteSubcontrol mutation

Fields

NameDescription

deletedID
ID!

Deleted subcontrol ID

SubcontrolEdge

An edge in a connection.

Fields

NameDescription

node
Subcontrol

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

SubcontrolHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
SubcontrolHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String!

the ID of the organization owner of the object

name
String!

the name of the subcontrol

description
String

description of the subcontrol

status
String

status of the subcontrol

subcontrolType
String

type of the subcontrol

version
String

version of the control

subcontrolNumber
String

number of the subcontrol

family
String

subcontrol family

class
String

subcontrol class

source
String

source of the control, e.g. framework, template, user-defined, etc.

mappedFrameworks
String

mapped frameworks that the subcontrol is part of

implementationEvidence
String

implementation evidence of the subcontrol

implementationStatus
String

implementation status

implementationDate
Time

date the subcontrol was implemented

implementationVerification
String

implementation verification

implementationVerificationDate
Time

date the subcontrol implementation was verified

details
Map

json data details of the subcontrol

SubcontrolHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[SubcontrolHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

SubcontrolHistoryEdge

An edge in a connection.

Fields

NameDescription

node
SubcontrolHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

SubcontrolSearchResult

Fields

NameDescription

subcontrols
[Subcontrol!]

SubcontrolUpdatePayload

Return response for updateSubcontrol mutation

Fields

NameDescription

subcontrol
Subcontrol!

Updated subcontrol

Subscriber

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

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

owner
Organization

events
[Event!]

SubscriberBulkCreatePayload

Return response for createBulkSubscriber mutation

Fields

NameDescription

subscribers
[Subscriber!]

Created subscribers

SubscriberConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

subscriber
Subscriber!

Created subscriber

SubscriberDeletePayload

Return response for deleteSubscriber mutation

Fields

NameDescription

email
String!

Deleted subscriber email

SubscriberEdge

An edge in a connection.

Fields

NameDescription

node
Subscriber

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

SubscriberSearchResult

Fields

NameDescription

subscribers
[Subscriber!]

SubscriberUpdatePayload

Return response for updateSubscriber mutation

Fields

NameDescription

subscriber
Subscriber!

Updated subscriber

Task

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

title
String!

the title of the task

description
String

the description of the task

details
Map

the details of the task

status
TaskTaskStatus!

the status of the task

due
Time

the due date of the task

completed
Time

the completion date of the task

assigner
User!

assignee
User

organization
[Organization!]

group
[Group!]

internalPolicy
[InternalPolicy!]

procedure
[Procedure!]

control
[Control!]

controlObjective
[ControlObjective!]

subcontrol
[Subcontrol!]

program
[Program!]

TaskBulkCreatePayload

Return response for createBulkTask mutation

Fields

NameDescription

tasks
[Task!]

Created tasks

TaskConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

task
Task!

Created task

TaskDeletePayload

Return response for deleteTask mutation

Fields

NameDescription

deletedID
ID!

Deleted task ID

TaskEdge

An edge in a connection.

Fields

NameDescription

node
Task

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

TaskHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
TaskHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

title
String!

the title of the task

description
String

the description of the task

details
Map

the details of the task

status
TaskHistoryTaskStatus!

the status of the task

due
Time

the due date of the task

completed
Time

the completion date of the task

TaskHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[TaskHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TaskHistoryEdge

An edge in a connection.

Fields

NameDescription

node
TaskHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

TaskSearchResult

Fields

NameDescription

tasks
[Task!]

TaskUpdatePayload

Return response for updateTask mutation

Fields

NameDescription

task
Task!

Updated task

Template

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
ID

the organization id that owns the object

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

jsonconfig
JSON!

the jsonschema object of the template

uischema
JSON

the uischema for the template to render in the UI

owner
Organization

documents
[DocumentData!]

files
[File!]

TemplateBulkCreatePayload

Return response for createBulkTemplate mutation

Fields

NameDescription

templates
[Template!]

Created templates

TemplateConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

template
Template!

Created template

TemplateDeletePayload

Return response for deleteTemplate mutation

Fields

NameDescription

deletedID
ID!

Deleted template ID

TemplateEdge

An edge in a connection.

Fields

NameDescription

node
Template

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

TemplateHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
TemplateHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

ownerID
String

the organization id that owns the object

name
String!

the name of the template

templateType
TemplateHistoryDocumentType!

the type of the template, either a provided template or an implementation (document)

description
String

the description of the template

jsonconfig
JSON!

the jsonschema object of the template

uischema
JSON

the uischema for the template to render in the UI

TemplateHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[TemplateHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

TemplateHistoryEdge

An edge in a connection.

Fields

NameDescription

node
TemplateHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

TemplateSearchResult

Fields

NameDescription

templates
[Template!]

TemplateUpdatePayload

Return response for updateTemplate mutation

Fields

NameDescription

template
Template!

Updated template

TFASetting

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

tags
[String!]

tags associated with the object

tfaSecret
String

TFA secret for the user

verified
Boolean!

specifies if the TFA device has been verified

recoveryCodes
[String!]

recovery codes for 2fa

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

NameDescription

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

NameDescription

tfaSetting
TFASetting!

Created tfaSetting

TFASettingEdge

An edge in a connection.

Fields

NameDescription

node
TFASetting

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

TFASettingSearchResult

Fields

NameDescription

tFASettings
[TFASetting!]

TFASettingUpdatePayload

Return response for updateTFASetting mutation

Fields

NameDescription

tfaSetting
TFASetting!

Updated tfaSetting

User

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

avatarLocalFile
String

The user's local avatar file

avatarLocalFileID
ID

The user's local avatar file id

avatarUpdatedAt
Time

The time the user's (local) avatar was last updated

lastSeen
Time

the time the user was last seen

sub
String

the Subject of the user JWT

authProvider
UserAuthProvider!

auth provider used to register the account

role
UserRole

the user's role

personalAccessTokens
[PersonalAccessToken!]

tfaSettings
[TFASetting!]

setting
UserSetting!

groups
[Group!]

organizations
[Organization!]

files
[File!]

file
File

events
[Event!]

actionPlans
[ActionPlan!]

subcontrols
[Subcontrol!]

assignerTasks
[Task!]

assigneeTasks
[Task!]

programs
[Program!]

groupMemberships
[GroupMembership!]

orgMemberships
[OrgMembership!]

programMemberships
[ProgramMembership!]

UserBulkCreatePayload

Return response for createBulkUser mutation

Fields

NameDescription

users
[User!]

Created users

UserConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

user
User!

Created user

UserDeletePayload

Return response for deleteUser mutation

Fields

NameDescription

deletedID
ID!

Deleted user ID

UserEdge

An edge in a connection.

Fields

NameDescription

node
User

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

UserHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
UserHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

deletedAt
Time

deletedBy
String

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

avatarLocalFile
String

The user's local avatar file

avatarLocalFileID
String

The user's local avatar file id

avatarUpdatedAt
Time

The time the user's (local) avatar was last updated

lastSeen
Time

the time the user was last seen

sub
String

the Subject of the user JWT

authProvider
UserHistoryAuthProvider!

auth provider used to register the account

role
UserHistoryRole

the user's role

UserHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[UserHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

UserHistoryEdge

An edge in a connection.

Fields

NameDescription

node
UserHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

UserSearchResult

Fields

NameDescription

users
[User!]

UserSetting

Implements

Fields

NameDescription

id
ID!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

userID
ID

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

files
[File!]

UserSettingBulkCreatePayload

Return response for createBulkUserSetting mutation

Fields

NameDescription

userSettings
[UserSetting!]

Created userSettings

UserSettingConnection

A connection to a list of items.

Fields

NameDescription

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

NameDescription

userSetting
UserSetting!

Created userSetting

UserSettingEdge

An edge in a connection.

Fields

NameDescription

node
UserSetting

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

UserSettingHistory

Implements

Fields

NameDescription

id
ID!

historyTime
Time!

ref
String

operation
UserSettingHistoryOpType!

createdAt
Time

updatedAt
Time

createdBy
String

updatedBy
String

tags
[String!]

tags associated with the object

deletedAt
Time

deletedBy
String

userID
String

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
UserSettingHistoryUserStatus!

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

UserSettingHistoryConnection

A connection to a list of items.

Fields

NameDescription

edges
[UserSettingHistoryEdge]

A list of edges.

pageInfo
PageInfo!

Information to aid in pagination.

totalCount
Int!

Identifies the total count of items in the connection.

UserSettingHistoryEdge

An edge in a connection.

Fields

NameDescription

node
UserSettingHistory

The item at the end of the edge.

cursor
Cursor!

A cursor for use in pagination.

UserSettingSearchResult

Fields

NameDescription

userSettings
[UserSetting!]

UserSettingUpdatePayload

Return response for updateUserSetting mutation

Fields

NameDescription

userSetting
UserSetting!

Updated userSetting

UserUpdatePayload

Return response for updateUser mutation

Fields

NameDescription

user
User!

Updated user