Connectors GraphQL API

On this page: ⫘

Query
Mutation
Objects
Inputs
Enums
- AuthType
- ConnectionVersionStrategy
Scalars
- Any
- Boolean
- ID
- IDs
- Int
- JSONObject
- JSONSchema
- SemVer
- String
- Tags
- Time
- Upload
Interfaces
- Node

Query ⫘

This XDR 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.

Field ⫘

node Type: Node ⫘

Arguments ⫘

id Type: ID! ⫘

Field ⫘

connectorCategory Type: ConnectorCategory ⫘

Arguments ⫘

connectorCategoryId Type: ID ⫘

connectorCategoryName Type: String ⫘

Field ⫘

connectorCategories Type: ConnectorCategory! ⫘

Arguments ⫘

arguments Type: ConnectorCategoriesArguments ⫘

Field ⫘

connectionMethod Type: ConnectionMethod ⫘

Arguments ⫘

connectionMethodId Type: ID ⫘

connectionMethodName Type: String ⫘

Field ⫘

connectionMethods Type: ConnectionMethod! ⫘

Field ⫘

connector Type: Connector ⫘

Arguments ⫘

connectorId Type: ID ⫘

connectorName Type: String ⫘

Field ⫘

connectors Type: Connector! ⫘

Arguments ⫘

connectorNames Type: String!] ⫘

connectionMethodIds Type: IDs ⫘

connectorVersionIds Type: IDs ⫘

connectorInterfaceIds Type: IDs ⫘

connectorCategoryIds Type: IDs ⫘

tags Type: Tags ⫘

Field ⫘

connectorVersion Type: ConnectorVersion ⫘

Arguments ⫘

arguments Type: ConnectorVersionArguments! ⫘

Field ⫘

connectorVersions Type: ConnectorVersion! ⫘

Arguments ⫘

arguments Type: ConnectorVersionsArguments! ⫘

Field ⫘

connection Type: Connection ⫘

Arguments ⫘

connectionId Type: ID ⫘

Field ⫘

connections Type: Connection! ⫘

Arguments ⫘

connectionIds Type: IDs ⫘

connectorIds Type: IDs ⫘

connectorVersionIds Type: IDs ⫘

connectorInterfaceIds Type: IDs ⫘

connectorCategoryIds Type: IDs ⫘

tags Type: Tags ⫘

Field ⫘

connectorExport Type: ConnectorExport ⫘

Arguments ⫘

arguments Type: ConnectorExportArguments! ⫘

Field ⫘

connectorTags Type: String! ⫘

Mutation ⫘

Field ⫘

defineConnectionMethod Type: ConnectionMethod ⫘

Define new connection method

Arguments ⫘

connectionMethod Type: ConnectionMethodInput! ⫘

Field ⫘

removeConnectionMethod Type: ConnectionMethod ⫘

Remove connection method

Arguments ⫘

connectorMethodId Type: ID! ⫘

Field ⫘

createConnector Type: Connector ⫘

Create new connector

Arguments ⫘

input Type: CreateConnectorInput! ⫘

Field ⫘

updateConnector Type: Connector ⫘

Update connector definition

Arguments ⫘

input Type: UpdateConnectorInput! ⫘

Field ⫘

deleteConnector Type: Connector ⫘

Delete connector

Arguments ⫘

input Type: DeleteConnectorInput! ⫘

Field ⫘

cloneConnector Type: Connector ⫘

Clone connector

Arguments ⫘

input Type: CloneConnectorInput! ⫘

Field ⫘

importConnector Type: Connector ⫘

Import a connector

Arguments ⫘

input Type: ImportConnectorInput! ⫘

Field ⫘

createConnectorVersion Type: ConnectorVersion ⫘

Creates a new connector version in draft mode

Arguments ⫘

connectorId Type: ID! ⫘

input Type: CreateConnectorVersionInput! ⫘

Field ⫘

updateConnectorVersion Type: ConnectorVersion ⫘

Update an existing draft connector version

Arguments ⫘

input Type: UpdateConnectorVersionInput! ⫘

Field ⫘

publishConnectorVersion Type: ConnectorVersion ⫘

Publishing a connector version makes it immutable and sets it as current head

Arguments ⫘

input Type: PublishConnectorVersionInput! ⫘

Field ⫘

deleteConnectorVersion Type: ConnectorVersion ⫘

Deleting a connector version is not supported after a version is published

Arguments ⫘

input Type: DeleteConnectorVersionInput! ⫘

Field ⫘

createConnection Type: Connection ⫘

Create new connection

Arguments ⫘

connectorId Type: ID! ⫘

connection Type: ConnectionInput! ⫘

Field ⫘

updateConnection Type: Connection ⫘

Update connection

Arguments ⫘

connectionId Type: ID! ⫘

connection Type: ConnectionInput! ⫘

Field ⫘

deleteConnection Type: Connection ⫘

Delete connection

Arguments ⫘

connectionId Type: ID! ⫘

Field ⫘

validateConnection Type: Connection ⫘

Validate an existing connection

Arguments ⫘

connectionId Type: ID! ⫘

Field ⫘

validateConnectionInput Type: Connector ⫘

Validate new connection

Arguments ⫘

connectorId Type: ID! ⫘

connection Type: ConnectionInput! ⫘

Field ⫘

executeConnectionAction Type: Any ⫘

Execute an action

Arguments ⫘

connectionId Type: ID! ⫘

actionName Type: String! ⫘

inputs Type: Any ⫘

Field ⫘

testConnectorAction Type: Any ⫘

Test a connector action

Arguments ⫘

input Type: TestConnectorActionInput! ⫘

Field ⫘

executeConnectorAction Type: Any ⫘

Execute a connector action

Arguments ⫘

name Type: String! ⫘

inputs Type: Any ⫘

Objects ⫘

Connection ⫘

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

Field ⫘

id Type: ID! ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

createdBy Type: String! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

lastUpdatedBy Type: String! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

connector Type: Connector! ⫘

Field ⫘

version Type: ConnectorVersion ⫘

Field ⫘

versionFollow Type: SemVer! ⫘

Field ⫘

versionStrategy Type: ConnectionVersionStrategy ⫘

Field ⫘

tags Type: String!] ⫘

Field ⫘

authType Type: AuthType! ⫘

Field ⫘

authUrl Type: String ⫘

Field ⫘

config Type: JSONObject ⫘

Field ⫘

credentials Type: JSONObject ⫘

Field ⫘

sequence Type: Int ⫘

Field ⫘

rateLimit Type: ConnectionRateLimit ⫘

Field ⫘

cluster Type: String ⫘

ConnectionMethod ⫘

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

Field ⫘

id Type: ID! ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

parameters Type: JSONSchema ⫘

Field ⫘

graphqlUrl Type: String! ⫘

Field ⫘

connectors Type: Connector! ⫘

ConnectionRateLimit ⫘

Field ⫘

interval Type: String ⫘

Field ⫘

limit Type: Int ⫘

Connector ⫘

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

Field ⫘

id Type: ID! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

createdBy Type: String! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

lastUpdatedBy Type: String! ⫘

Field ⫘

sequence Type: Int ⫘

Field ⫘

tenant Type: String ⫘

Field ⫘

icon Type: String ⫘

Field ⫘

tags Type: String!] ⫘

Field ⫘

categories Type: ConnectorCategory! ⫘

Field ⫘

connections Type: Connection!] ⫘

Field ⫘

method Type: ConnectionMethod! ⫘

Field ⫘

head Type: ConnectorVersion! ⫘

Field ⫘

versions Type: ConnectorVersion! ⫘

ConnectorAction ⫘

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

Field ⫘

id Type: ID! ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

createdBy Type: String! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

lastUpdatedBy Type: String! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

version Type: ConnectorVersion ⫘

Field ⫘

description Type: String ⫘

Field ⫘

inputs Type: JSONSchema ⫘

Field ⫘

outputs Type: JSONSchema ⫘

Field ⫘

config Type: JSONObject ⫘

ConnectorCategory ⫘

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

Field ⫘

id Type: ID! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

tags Type: String!] ⫘

ConnectorExport ⫘

Field ⫘

export Type: String! ⫘

ConnectorRateLimit ⫘

Field ⫘

defaultInterval Type: String ⫘

Field ⫘

defaultLimit Type: Int ⫘

Field ⫘

maxInterval Type: String ⫘

Field ⫘

maxLimit Type: Int ⫘

Field ⫘

minInterval Type: String ⫘

Field ⫘

minLimit Type: Int ⫘

ConnectorVersion ⫘

ConnectorVersion contains the versioned attributes of a connector interface

Field ⫘

id Type: ID! ⫘

Field ⫘

version Type: SemVer ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

createdBy Type: String! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

lastUpdatedBy Type: String! ⫘

Field ⫘

published Type: Time ⫘

Field ⫘

publishedBy Type: String ⫘

Field ⫘

connector Type: Connector! ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

title Type: String ⫘

Field ⫘

description Type: String ⫘

Field ⫘

documentation Type: String ⫘

Field ⫘

changeNotes Type: String ⫘

Field ⫘

changeNotesMarkdown Type: String ⫘

Field ⫘

metadata Type: JSONObject ⫘

Field ⫘

connections Type: Connection! ⫘

Field ⫘

parameters Type: JSONSchema ⫘

Field ⫘

actions Type: ConnectorAction! ⫘

Field ⫘

authTypes Type: AuthType! ⫘

Field ⫘

authenticate Type: ConnectorAction ⫘

Field ⫘

validate Type: ConnectorAction ⫘

Field ⫘

vendorName Type: String ⫘

Field ⫘

vendorProduct Type: String ⫘

Field ⫘

vendorVersion Type: String ⫘

Field ⫘

rateLimit Type: ConnectorRateLimit ⫘

DeletedObject ⫘

Field ⫘

id Type: ID! ⫘

Field ⫘

createdAt Type: Time! ⫘

Field ⫘

updatedAt Type: Time! ⫘

Field ⫘

deletedAt Type: Time! ⫘

Field ⫘

createdBy Type: String! ⫘

Field ⫘

lastUpdatedBy Type: String ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

tags Type: String!] ⫘

Field ⫘

sequence Type: Int ⫘

Subscription ⫘

Subscriptions provide ability to receive asynchronous notification of CRUD events

Field ⫘

connectorCreated Type: Connector! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Field ⫘

connectorUpdated Type: Connector! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Field ⫘

connectorDeleted Type: DeletedObject! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Field ⫘

connectionCreated Type: Connection! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

connectorIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Field ⫘

connectionUpdated Type: Connection! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

connectorIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Field ⫘

connectionDeleted Type: DeletedObject! ⫘

Arguments ⫘

connectorMethodIds Type: IDs ⫘

connectorIds Type: IDs ⫘

allTenants Type: Boolean! ⫘

Inputs ⫘

CloneConnectorInput ⫘

Field ⫘

name Type: String! ⫘

Field ⫘

connectorId Type: ID! ⫘

Field ⫘

versionId Type: ID! ⫘

ConnectionAPIKeyAuth ⫘

Field ⫘

param Type: String! ⫘

Field ⫘

value Type: String! ⫘

Field ⫘

header Type: String! ⫘

ConnectionBasicAuth ⫘

Field ⫘

username Type: String! ⫘

Field ⫘

password Type: String! ⫘

ConnectionClientCertificateAuth ⫘

Field ⫘

certificate Type: String! ⫘

Field ⫘

privateKey Type: String! ⫘

Field ⫘

privateKeyPassword Type: String ⫘

ConnectionCredentialsInput ⫘

Field ⫘

rawAuth Type: ConnectionRawAuth ⫘

Field ⫘

basicAuth Type: ConnectionBasicAuth ⫘

Field ⫘

apiKeyAuth Type: ConnectionAPIKeyAuth ⫘

Field ⫘

clientCredentialsAuth Type: ConnectionOAuth2ClientCredsAuth ⫘

Field ⫘

clientCertificateAuth Type: ConnectionClientCertificateAuth ⫘

Field ⫘

ownerPasswordCredentialsAuth Type: ConnectionOAuth2PasswordCredsAuth ⫘

Field ⫘

authCodeAuth Type: ConnectionOAuth2AuthCodeAuth ⫘

ConnectionInput ⫘

ConnectionInput defines the mutable fields of a connection

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

tags Type: Tags ⫘

Field ⫘

config Type: JSONObject ⫘

Field ⫘

credentials Type: JSONObject ⫘

Field ⫘

authType Type: AuthType ⫘

Field ⫘

authUrl Type: String ⫘

Field ⫘

version Type: ID ⫘

Field ⫘

versionStrategy Type: ConnectionVersionStrategy ⫘

Field ⫘

versionFollow Type: SemVer ⫘

Field ⫘

rateLimit Type: ConnectionRateLimitInput ⫘

Field ⫘

cluster Type: String ⫘

ConnectionMethodInput ⫘

ConnectionMethodInput defines the fields required to register a new connection method

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

url Type: String! ⫘

Field ⫘

parameters Type: JSONSchema ⫘

Field ⫘

tags Type: Tags ⫘

ConnectionOAuth2AuthCodeAuth ⫘

Field ⫘

clientId Type: String! ⫘

Field ⫘

clientSecret Type: String! ⫘

Field ⫘

scopes Type: String!] ⫘

Field ⫘

authCode Type: String! ⫘

ConnectionOAuth2ClientCredsAuth ⫘

Field ⫘

clientId Type: String! ⫘

Field ⫘

clientSecret Type: String! ⫘

Field ⫘

scopes Type: String! ⫘

ConnectionOAuth2PasswordCredsAuth ⫘

Field ⫘

clientId Type: String! ⫘

Field ⫘

clientSecret Type: String! ⫘

Field ⫘

scopes Type: String! ⫘

Field ⫘

Username Type: String! ⫘

Field ⫘

Password Type: String! ⫘

ConnectionRateLimitInput ⫘

Field ⫘

interval Type: String! ⫘

Field ⫘

limit Type: Int! ⫘

ConnectionRawAuth ⫘

Field ⫘

value Type: String! ⫘

ConnectorActionInput ⫘

ConnectorActionInput defines the mutable fields of a connector action declaration

Field ⫘

name Type: String! ⫘

Field ⫘

description Type: String ⫘

Field ⫘

inputs Type: JSONSchema ⫘

Field ⫘

outputs Type: JSONSchema ⫘

Field ⫘

config Type: JSONObject ⫘

ConnectorCategoriesArguments ⫘

ConnectorCategoriesArguments defines the filters and options for listing connectorCategories

Field ⫘

connectorCategoryNames Type: String! ⫘

Field ⫘

connectorCategoryIds Type: IDs ⫘

ConnectorExportArguments ⫘

Field ⫘

connectorId Type: ID ⫘

Field ⫘

name Type: String ⫘

ConnectorRateLimitInput ⫘

Field ⫘

defaultInterval Type: String! ⫘

Field ⫘

defaultLimit Type: Int! ⫘

Field ⫘

maxInterval Type: String! ⫘

Field ⫘

maxLimit Type: Int! ⫘

Field ⫘

minInterval Type: String! ⫘

Field ⫘

minLimit Type: Int! ⫘

ConnectorVersionArguments ⫘

ConnectorVersionArguments defines the filters and options for listing connectorVersions

Field ⫘

connectorVersionName Type: String ⫘

Field ⫘

connectorVersionId Type: ID ⫘

ConnectorVersionsArguments ⫘

ConnectorVersionsArguments defines the filters and options for listing connectorVersions

Field ⫘

connectorVersionNames Type: String! ⫘

Field ⫘

connectorVersionIds Type: IDs ⫘

CreateConnectorInput ⫘

ConnectorInput defines the fields required to create a connector

Field ⫘

name Type: String! ⫘

Field ⫘

tags Type: Tags ⫘

Field ⫘

icon Type: String ⫘

Field ⫘

categories Type: IDs ⫘

Field ⫘

method Type: ID! ⫘

Field ⫘

version Type: CreateConnectorVersionInput! ⫘

CreateConnectorVersionInput ⫘

CreateConnectorVersionInput defines the versioned fields of a connector

Field ⫘

title Type: String ⫘

Field ⫘

description Type: String ⫘

Field ⫘

documentation Type: String ⫘

Field ⫘

changeNotes Type: String ⫘

Field ⫘

changeNotesMarkdown Type: String ⫘

Field ⫘

vendorName Type: String ⫘

Field ⫘

vendorProduct Type: String ⫘

Field ⫘

vendorVersion Type: String ⫘

Field ⫘

metadata Type: JSONObject ⫘

Field ⫘

parameters Type: JSONSchema ⫘

Field ⫘

actions Type: ConnectorActionInput! ⫘

Field ⫘

authTypes Type: AuthType! ⫘

Field ⫘

version Type: SemVer ⫘

Field ⫘

rateLimit Type: ConnectorRateLimitInput ⫘

DeleteConnectorInput ⫘

DeleteConnectorInput defines the mutable metadata fields of a connector

Field ⫘

connectorId Type: ID! ⫘

DeleteConnectorVersionInput ⫘

DeleteConnectorVersionInput

Field ⫘

connectorVersionId Type: ID! ⫘

ImportConnectorInput ⫘

Field ⫘

file Type: Upload! ⫘

PublishConnectorVersionInput ⫘

PublishConnectorVersionInput

Field ⫘

connectorVersionId Type: ID! ⫘

Field ⫘

version Type: SemVer! ⫘

TestConnectorActionInput ⫘

Field ⫘

connection Type: ConnectionInput! ⫘

Field ⫘

connectionMethodName Type: String! ⫘

Field ⫘

action Type: ConnectorActionInput! ⫘

Field ⫘

inputs Type: Any ⫘

UpdateConnectorInput ⫘

UpdateConnectorInput defines the mutable metadata fields of a connector

Field ⫘

connectorId Type: ID! ⫘

Field ⫘

tags Type: Tags ⫘

Field ⫘

icon Type: String ⫘

Field ⫘

categories Type: IDs ⫘

Field ⫘

head Type: ID ⫘

UpdateConnectorVersionInput ⫘

UpdateConnectorVersionInput defines the versioned fields of a connector

Field ⫘

connectorVersionId Type: ID! ⫘

Field ⫘

title Type: String ⫘

Field ⫘

description Type: String ⫘

Field ⫘

documentation Type: String ⫘

Field ⫘

changeNotes Type: String ⫘

Field ⫘

changeNotesMarkdown Type: String ⫘

Field ⫘

vendorName Type: String ⫘

Field ⫘

vendorProduct Type: String ⫘

Field ⫘

vendorVersion Type: String ⫘

Field ⫘

metadata Type: JSONObject ⫘

Field ⫘

parameters Type: JSONSchema ⫘

Field ⫘

actions Type: ConnectorActionInput! ⫘

Field ⫘

authTypes Type: AuthType! ⫘

Field ⫘

version Type: SemVer ⫘

Field ⫘

rateLimit Type: ConnectorRateLimitInput ⫘

Enums ⫘

AuthType ⫘

Enumeration of supported auth types

None

Platform

Raw

Basic

APIKey

ClientCerts

OAuthClientCreds

OAuthPassword

OAuthAuthCode

OAuthJWT

Custom

AWSv4

ConnectionVersionStrategy ⫘

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

Fixed

FollowHead

FollowMinorVersion

FollowMajorVersion

Scalars ⫘

Any ⫘

Boolean ⫘

The Boolean scalar type represents true or false.

ID ⫘

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

IDs ⫘

List of IDs

Int ⫘

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

JSONObject ⫘

JSON payload

JSONSchema ⫘

JSON Schema

SemVer ⫘

version string in semver format

String ⫘

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.