Connectors GraphQL API🔗

Query🔗

Description: Red Cloak TDR API is based on GraphQL, which can either be a read (Query) or a write (Mutation) operation. A GraphQL query is used to read or fetch values; mutations write or post values. Responses are provided in a JSON format.

Fields🔗

Field	Type	Description	Arguments
node	Node		id: ID
connectorCategory	ConnectorCategory		connectorCategoryId: ID, connectorCategoryName: String
connectorCategories	ConnectorCategory		arguments: ConnectorCategoriesArguments
connectionMethod	ConnectionMethod		connectionMethodId: ID, connectionMethodName: String
connectionMethods	ConnectionMethod
connector	Connector		connectorId: ID, connectorName: String
connectors	Connector		connectorNames: String, connectionMethodIds: IDs, connectorVersionIds: IDs, connectorInterfaceIds: IDs, connectorCategoryIds: IDs, connectorIds: IDs, tags: Tags
connectorsV2	Connectors		arguments: ConnectorsV2Arguments
connectorList	Connectors		arguments: ConnectorListArguments
connectorVersion	ConnectorVersion		arguments: ConnectorVersionArguments
connectorVersions	ConnectorVersion		arguments: ConnectorVersionsArguments
connection	Connection		connectionId: ID
connections	Connection		connectionIds: IDs, connectorIds: IDs, connectorVersionIds: IDs, connectorInterfaceIds: IDs, connectorCategoryIds: IDs, tags: Tags
connectorExport	ConnectorExport		arguments: ConnectorExportArguments
connectorTags	String
reconcileConnectionVersions	Connection	Reconcile a version change with an existing connection	arguments: ReconcileConnectionVersionsArguments

ID🔗

Description: The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

String🔗

Description: The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

ConnectorCategoriesArguments🔗

Description: ConnectorCategoriesArguments defines the filters and options for listing connectorCategories

Fields🔗

Field	Type	Description	Arguments
connectorCategoryNames	String
connectorCategoryIds	IDs

ConnectorVersionArguments🔗

Description: ConnectorVersionArguments defines the filters and options for listing connectorVersions

Fields🔗

Field	Type	Description	Arguments
connectorVersionName	String
connectorVersionId	ID

ConnectorVersionsArguments🔗

Description: ConnectorVersionsArguments defines the filters and options for listing connectorVersions

Fields🔗

Field	Type	Description	Arguments
connectorVersionNames	String
connectorVersionIds	IDs

ConnectorExportArguments🔗

Fields🔗

Field	Type	Description
connectorId	ID
name	String
connectorVersionId	ID	Optional - if set, then the export will export the connector with the specified version by id otherwise it will default to the head version. If both version and connectorVersionId are set, then connectorVersionId will override the version field (the SemVer will still need to be valid).
version	SemVer	Optional - if set, then the export will export the connector with the specified version by semver otherwise it will default to the head version. If both version and connectorVersionId are set, then connectorVersionId will override this field.

Pagination🔗

Description: Pagination defines the options for requesting specific pages and the number of results per page

Fields🔗

Field	Type	Description	Arguments
page	Int
perPage	Int

Int🔗

Description: The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

ConnectorsV2Arguments🔗

Description: ConnectorV2Arguments defines the filter and options for listing Connectors

Fields🔗

Field	Type	Description	Arguments
connectorNames	String
connectionMethodIds	IDs
connectorVersionIds	IDs
connectorInterfaceIds	IDs
connectorCategoryIds	IDs
connectorIds	IDs
tags	Tags
includePlatformConnectors	Boolean
pagination	Pagination

Boolean🔗

Description: The Boolean scalar type represents true or false.

ConnectorListArguments🔗

Description: ConnectorV3Arguments defines the filter and options for listing Connectors

Fields🔗

Field	Type	Description
pagination	Pagination
order	PaginationOrder
sortField	ConnectorsSortField
searchText	String	If set, case-insensitive search across connector name, title, and description
tags	Tags
isDeprecated	Boolean
isGlobal	Boolean

ReconcileConnectionVersionsArguments🔗

Fields🔗

Field	Type	Description	Arguments
connectionId	ID
connectorVersionId	ID

Connectors🔗

Fields🔗

Field	Type	Description	Arguments
connectors	Connector
totalCount	Int

Node🔗

Fields🔗

Field	Type	Description	Arguments
id	ID

TDRUser🔗

Description: Used by Nautilus to resolve the Red Cloak TDR user model.

Fields🔗

Field	Type	Description	Arguments
id	ID

Subject🔗

Fields🔗

Field	Type	Description	Arguments
id	ID

PaginationOrder🔗

Description: PaginationOrder defines the fields that may be used to order the results in ascending or descending order. Note that ASCENDING is the default.

ConnectorsSortField🔗

Description: ConnectorsSortField determines the sort order of a list of Connectors. If no sort order is provided, Connectors will be sorted by NAME.

AuthType🔗

Description: Enumeration of supported auth types

ConnectorCategory🔗

Description: ConnectorCategory is a grouping/categorization of available connectors (e.g. IP reputation services, DNS lookup, etc)

Fields🔗

Field	Type	Description	Arguments
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
description	String
tags	String

ConnectorAction🔗

Description: ConnectorAction declares a method or activity that can be called on a connector and its corresponding input and output

Fields🔗

Field	Type	Description
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
version	ConnectorVersion
description	String
inputs	JSONSchema
outputs	JSONSchema
config	JSONObject
updatedByUser	TDRUser	deprecated: do not use
createdByUser	TDRUser

ConnectionMethod🔗

Description: ConnectionMethod references a service that implements connectors of a specific connection method (e.g. http, grpc, graphql)

Fields🔗

Field	Type	Description	Arguments
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
description	String
parameters	JSONSchema
graphqlUrl	String
connectors	Connector
rn	RN

Connector🔗

Description: Connector is an entry in catalog of available connectors (e.g. service now connector based on generic http connector service)

Fields🔗

Field	Type	Description
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
sequence	Int
tenant	String
icon	String
tags	String
categories	ConnectorCategory
connections	Connection
method	ConnectionMethod
head	ConnectorVersion
versions	ConnectorVersion
rn	RN
isGlobal	Boolean
updatedByUser	TDRUser	deprecated: do not use
createdByUser	TDRUser

ConnectorRateLimit🔗

Fields🔗

Field	Type	Description	Arguments
defaultInterval	String
defaultLimit	Int
maxInterval	String
maxLimit	Int
minInterval	String
minLimit	Int

ConnectorVersion🔗

Description: ConnectorVersion contains the versioned attributes of a connector interface

Fields🔗

Field	Type	Description
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
version	SemVer
published	Time
publishedBy	String
publishedBySubject	Subject
connector	Connector
name	String
tenant	String
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
metadata	JSONObject
connections	Connection
parameters	JSONSchema
actions	ConnectorAction
authTypes	AuthType
authDefaults	JSONObject
authenticate	ConnectorAction
validate	ConnectorAction
vendorName	String
vendorProduct	String
vendorVersion	String
rateLimit	ConnectorRateLimit
permissions	String
rn	RN
deprecated	Boolean
deprecationReason	String
updatedByUser	TDRUser	deprecated: do not use
createdByUser	TDRUser

DeletedObject🔗

Fields🔗

Field	Type	Description
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
deletedAt	Time
name	String
description	String
tags	String
sequence	Int
updatedByUser	TDRUser	deprecated: do not use
createdByUser	TDRUser

ConnectionVersionStrategy🔗

Description: ConnectionVersionStrategy determines how the connection is upgraded when new versions are published

Connection🔗

Description: Connection is a per-tenant configuration of a connector/actions

Fields🔗

Field	Type	Description
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
description	String
connector	Connector
version	ConnectorVersion
versionFollow	SemVer
versionStrategy	ConnectionVersionStrategy
tags	String
authType	AuthType
authUrl	String
config	JSONObject
credentials	JSONObject
sequence	Int
rateLimit	ConnectionRateLimit
cluster	String
caCertificate	String
ignoreCertValidation	Boolean
rn	RN
updatedByUser	TDRUser	deprecated: do not use
createdByUser	TDRUser

ConnectionRateLimit🔗

Fields🔗

Field	Type	Description	Arguments
interval	String
limit	Int

Mutation🔗

Fields🔗

Field	Type	Description	Arguments
defineConnectionMethod	ConnectionMethod	Define new connection method	connectionMethod: ConnectionMethodInput
removeConnectionMethod	ConnectionMethod	Remove connection method	connectorMethodId: ID
createConnector	Connector	Create new connector	input: CreateConnectorInput
updateConnector	Connector	Update connector definition	input: UpdateConnectorInput
deleteConnector	Connector	Delete connector	input: DeleteConnectorInput
cloneConnector	Connector	Clone connector	input: CloneConnectorInput
importConnector	Connector	Import a connector	input: ImportConnectorInput
deprecateConnector	Connector	Deprecate a connector	input: DeprecateConnectorInput
undeprecateConnector	Connector	Undeprecate a connector	input: UndeprecateConnectorInput
createConnectorVersion	ConnectorVersion	Creates a new connector version in draft mode	connectorId: ID, input: CreateConnectorVersionInput
updateConnectorVersion	ConnectorVersion	Update an existing draft connector version	input: UpdateConnectorVersionInput
publishConnectorVersion	ConnectorVersion	Publishing a connector version makes it immutable and sets it as current head	input: PublishConnectorVersionInput
deleteConnectorVersion	ConnectorVersion	Deleting a connector version is not supported after a version is published	input: DeleteConnectorVersionInput
deprecateConnectorVersion	ConnectorVersion	Deprecate a connector version	input: DeprecateConnectorVersionInput
undeprecateConnectorVersion	ConnectorVersion	Undeprecate a connector version	input: UndeprecateConnectorVersionInput
createConnection	Connection	Create new connection	connectorId: ID, connection: ConnectionInput
updateConnection	Connection	Update connection	connectionId: ID, connection: ConnectionInput
updateConnectionV2	Connection	Update connection with optional fields. This update will not update fields that are not sent in the request. It is a PATCH not a PUT	input: UpdateConnectionInput
deleteConnection	Connection	Delete connection	connectionId: ID
validateConnection	Connection	Validate an existing connection	connectionId: ID
validateConnectionInput	Connector	Validate new connection	connectorId: ID, connection: ConnectionInput
executeConnectionAction	Any	Execute an action	connectionId: ID, actionName: String, inputs: Any
testConnectorAction	Any	Test a connector action	input: TestConnectorActionInput
executeConnectorAction	Any	Execute a connector action	name: String, inputs: Any
verifyConnectorAction	Any	Test a connector action	connectorId: ID, input: TestConnectorActionInput

ConnectionMethodInput🔗

Description: ConnectionMethodInput defines the fields required to register a new connection method

Fields🔗

Field	Type	Description	Arguments
name	String
description	String
url	String
parameters	JSONSchema
tags	Tags

ConnectorActionInput🔗

Description: ConnectorActionInput defines the mutable fields of a connector action declaration

Fields🔗

Field	Type	Description	Arguments
name	String
description	String
inputs	JSONSchema
outputs	JSONSchema
config	JSONObject

CreateConnectorInput🔗

Description: ConnectorInput defines the fields required to create a connector

Fields🔗

Field	Type	Description	Arguments
name	String
tags	Tags
icon	String
categories	IDs
method	ID
version	CreateConnectorVersionInput

UpdateConnectorInput🔗

Description: UpdateConnectorInput defines the mutable metadata fields of a connector

Fields🔗

Field	Type	Description	Arguments
connectorId	ID
tags	Tags
icon	String
categories	IDs
head	ID

DeleteConnectorInput🔗

Description: DeleteConnectorInput defines the mutable metadata fields of a connector

Fields🔗

Field	Type	Description	Arguments
connectorId	ID

ConnectorRateLimitInput🔗

Fields🔗

Field	Type	Description	Arguments
defaultInterval	String
defaultLimit	Int
maxInterval	String
maxLimit	Int
minInterval	String
minLimit	Int

CloneConnectorInput🔗

Fields🔗

Field	Type	Description
name	String
connectorId	ID
versionId	ID
title	String	Optional new title for cloned Connector

CreateConnectorVersionInput🔗

Description: CreateConnectorVersionInput defines the versioned fields of a connector

Fields🔗

Field	Type	Description	Arguments
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
vendorName	String
vendorProduct	String
vendorVersion	String
metadata	JSONObject
parameters	JSONSchema
actions	ConnectorActionInput
authTypes	AuthType
authDefaults	ConnectorAuthDefaultsInput
version	SemVer
rateLimit	ConnectorRateLimitInput
permissions	String

UpdateConnectorVersionInput🔗

Description: UpdateConnectorVersionInput defines the versioned fields of a connector

Fields🔗

Field	Type	Description	Arguments
connectorVersionId	ID
title	String
description	String
documentation	String
changeNotes	String
changeNotesMarkdown	String
vendorName	String
vendorProduct	String
vendorVersion	String
metadata	JSONObject
parameters	JSONSchema
actions	ConnectorActionInput
authTypes	AuthType
authDefaults	ConnectorAuthDefaultsInput
version	SemVer
rateLimit	ConnectorRateLimitInput
permissions	String

PublishConnectorVersionInput🔗

Description: PublishConnectorVersionInput

Fields🔗

Field	Type	Description	Arguments
connectorVersionId	ID
version	SemVer

DeleteConnectorVersionInput🔗

Description: DeleteConnectorVersionInput

Fields🔗

Field	Type	Description	Arguments
connectorVersionId	ID

ImportConnectorInput🔗

Fields🔗

Field	Type	Description	Arguments
file	Upload

DeprecateConnectorVersionInput🔗

Description: DeprecateConnectorVersionInput

Fields🔗

Field	Type	Description	Arguments
connectorVersionId	ID
deprecationReason	String

UndeprecateConnectorVersionInput🔗

Description: UndeprecateConnectorVersionInput

Fields🔗

Field	Type	Description	Arguments
connectorVersionId	ID

DeprecateConnectorInput🔗

Description: DeprecateConnectorInput

Fields🔗

Field	Type	Description	Arguments
connectorId	ID
deprecationReason	String

UndeprecateConnectorInput🔗

Description: UndeprecateConnectorInput

Fields🔗

Field	Type	Description	Arguments
connectorId	ID

TestConnectorActionInput🔗

Fields🔗

Field	Type	Description	Arguments
connection	ConnectionInput
connectionMethodName	String
action	ConnectorActionInput
inputs	Any

ConnectionRawAuth🔗

Fields🔗

Field	Type	Description	Arguments
value	String

ConnectionBasicAuth🔗

Fields🔗

Field	Type	Description	Arguments
username	String
password	String

ConnectionAPIKeyAuth🔗

Fields🔗

Field	Type	Description	Arguments
param	String
value	String
header	String

ConnectionOAuth2ClientCredsAuth🔗

Fields🔗

Field	Type	Description	Arguments
clientId	String
clientSecret	String
scopes	String

ConnectionClientCertificateAuth🔗

Fields🔗

Field	Type	Description	Arguments
certificate	String
privateKey	String
privateKeyPassword	String

ConnectionOAuth2PasswordCredsAuth🔗

Fields🔗

Field	Type	Description	Arguments
clientId	String
clientSecret	String
scopes	String
Username	String
Password	String

ConnectionOAuth2AuthCodeAuth🔗

Fields🔗

Field	Type	Description	Arguments
clientId	String
clientSecret	String
scopes	String
authCode	String

ConnectionCredentialsInput🔗

Fields🔗

Field	Type	Description	Arguments
rawAuth	ConnectionRawAuth
basicAuth	ConnectionBasicAuth
apiKeyAuth	ConnectionAPIKeyAuth
clientCredentialsAuth	ConnectionOAuth2ClientCredsAuth
clientCertificateAuth	ConnectionClientCertificateAuth
ownerPasswordCredentialsAuth	ConnectionOAuth2PasswordCredsAuth
authCodeAuth	ConnectionOAuth2AuthCodeAuth

ConnectorAuthDefaultsInput🔗

Description: ConnectorAuthDefaultsInput defines any default values to suggest during Connection creation.

Fields🔗

Field	Type	Description	Arguments
url	String
basicAuth	ConnectionBasicAuth
apiKeyAuth	ConnectionAPIKeyAuth
clientCredentialsAuth	ConnectionOAuth2ClientCredsAuth
clientCertificateAuth	ConnectionClientCertificateAuth
ownerPasswordCredentialsAuth	ConnectionOAuth2PasswordCredsAuth
authCodeAuth	ConnectionOAuth2AuthCodeAuth

ConnectionInput🔗

Description: ConnectionInput defines the mutable fields of a connection

Fields🔗

Field	Type	Description	Arguments
connectionId	String
name	String
description	String
tags	Tags
config	JSONObject
credentials	JSONObject
authType	AuthType
authUrl	String
version	ID
versionStrategy	ConnectionVersionStrategy
versionFollow	SemVer
rateLimit	ConnectionRateLimitInput
cluster	String
caCertificate	String
ignoreCertValidation	Boolean
workflowID	String

UpdateConnectionInput🔗

Description: UpdateConnectionInput defines the mutable fields of a connection

Fields🔗

Field	Type	Description	Arguments
connectionId	ID
name	String
description	String
tags	Tags
config	JSONObject
credentials	JSONObject
authType	AuthType
authUrl	String
version	ID
versionStrategy	ConnectionVersionStrategy
versionFollow	SemVer
rateLimit	ConnectionRateLimitInput
cluster	String
caCertificate	String
ignoreCertValidation	Boolean