コネクター GraphQL API

クエリ

説明: Red Cloak TDR APIはGraphQLに基づいており、読み取り（Query）または書き込み（Mutation）操作のいずれかを実行できます。GraphQLクエリは値の読み取りや取得に使用され、ミューテーションは値の書き込みや投稿に使用されます。レスポンスはJSON形式で提供されます。

フィールド

フィールド	型	説明	引数
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	既存の接続でバージョン変更を調整します	arguments: ReconcileConnectionVersionsArguments

ID

説明: IDスカラ型は一意の識別子を表し、オブジェクトの再取得やキャッシュのキーとしてよく使用されます。ID型はJSONレスポンスではStringとして表示されますが、人間が読めることを意図していません。入力型として期待される場合、任意の文字列（例: "4"）や整数（例: 4）の入力値がIDとして受け入れられます。

String

説明: Stringスカラ型はテキストデータを表し、UTF-8文字列として表現されます。String型はGraphQLで自由形式の人間が読めるテキストを表現するためによく使用されます。

ConnectorCategoriesArguments

説明: ConnectorCategoriesArgumentsはconnectorCategoriesの一覧表示のためのフィルターとオプションを定義します

フィールド

フィールド	型	説明	引数
connectorCategoryNames	String
connectorCategoryIds	IDs

ConnectorVersionArguments

説明: ConnectorVersionArgumentsはconnectorVersionsの一覧表示のためのフィルターとオプションを定義します

フィールド

フィールド	型	説明	引数
connectorVersionName	String
connectorVersionId	ID

ConnectorVersionsArguments

説明: ConnectorVersionsArgumentsはconnectorVersionsの一覧表示のためのフィルターとオプションを定義します

フィールド

フィールド	型	説明	引数
connectorVersionNames	String
connectorVersionIds	IDs

ConnectorExportArguments

フィールド

フィールド	型	説明	引数
connectorId	ID
name	String
connectorVersionId	ID	オプション - 設定されている場合、指定されたIDのバージョンでコネクターをエクスポートします。設定されていない場合は最新バージョンがデフォルトとなります。 versionとconnectorVersionIdの両方が設定されている場合、connectorVersionIdがversionフィールドより優先されます（SemVerは有効である必要があります）。
version	SemVer	オプション - 設定されている場合、指定されたsemverバージョンでコネクターをエクスポートします。設定されていない場合は最新バージョンがデフォルトとなります。 versionとconnectorVersionIdの両方が設定されている場合、connectorVersionIdがこのフィールドより優先されます。

ページネーション

説明: ページネーションは、特定のページや1ページあたりの結果数をリクエストするためのオプションを定義します

フィールド

フィールド	型	説明	引数
page	Int
perPage	Int

Int

説明: Intスカラ型は小数点を含まない符号付き整数値を表します。Intは-(2^31)から2^31 - 1までの値を表現できます。

ConnectorsV2Arguments

説明: ConnectorV2ArgumentsはConnectorsの一覧表示のためのフィルターとオプションを定義します

フィールド

フィールド	型	説明	引数
connectorNames	String
connectionMethodIds	IDs
connectorVersionIds	IDs
connectorInterfaceIds	IDs
connectorCategoryIds	IDs
connectorIds	IDs
tags	Tags
includePlatformConnectors	Boolean
pagination	Pagination

Boolean

説明: Booleanスカラ型はtrueまたはfalseを表します。

ConnectorListArguments

説明: ConnectorV3ArgumentsはConnectorsの一覧表示のためのフィルターとオプションを定義します

フィールド

フィールド	型	説明	引数
pagination	Pagination
order	PaginationOrder
sortField	ConnectorsSortField
searchText	String	設定されている場合、コネクター名、タイトル、説明に対して大文字小文字を区別しない検索を行います
tags	Tags
isDeprecated	Boolean
isGlobal	Boolean

ReconcileConnectionVersionsArguments

フィールド

フィールド	型	説明	引数
connectionId	ID
connectorVersionId	ID

Connectors

フィールド

フィールド	型	説明	引数
connectors	Connector
totalCount	Int

Node

フィールド

フィールド	型	説明	引数
id	ID

TDRUser

説明: NautilusでRed Cloak TDRユーザーモデルを解決するために使用されます。

フィールド

フィールド	型	説明	引数
id	ID

Subject

フィールド

フィールド	型	説明	引数
id	ID

PaginationOrder

説明: PaginationOrderは、結果を昇順または降順で並べ替える際に使用できるフィールドを定義します。ASCENDINGがデフォルトです。

ConnectorsSortField

説明: ConnectorsSortFieldは、コネクター一覧の並び順を決定します。並び順が指定されていない場合、NAMEでソートされます。

AuthType

説明: サポートされている認証タイプの列挙

ConnectorCategory

説明: ConnectorCategoryは利用可能なコネクターのグループ化／カテゴリ分けです（例: IPレピュテーションサービス、DNSルックアップなど）

フィールド

フィールド	型	説明	引数
id	ID
createdAt	Time
createdBy	String
createdBySubject	Subject
updatedAt	Time
lastUpdatedBy	String
lastUpdatedBySubject	Subject
name	String
description	String
tags	String

ConnectorAction

説明: ConnectorActionは、コネクターで呼び出せるメソッドやアクティビティ、その対応する入力・出力を宣言します

フィールド

フィールド	型	説明	引数
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	非推奨: 使用しないでください
createdByUser	TDRUser

ConnectionMethod

説明: ConnectionMethodは、特定の接続方式（例: http, grpc, graphql）でコネクターを実装するサービスを参照します

フィールド

フィールド	型	説明	引数
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

説明: Connectorは利用可能なコネクターのカタログエントリです（例: generic httpコネクターサービスに基づくServiceNowコネクター）

フィールド

フィールド	型	説明	引数
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	非推奨: 使用しないでください
createdByUser	TDRUser

ConnectorRateLimit

フィールド

フィールド	型	説明	引数
defaultInterval	String
defaultLimit	Int
maxInterval	String
maxLimit	Int
minInterval	String
minLimit	Int

ConnectorVersion

説明: ConnectorVersionはコネクターインターフェースのバージョン属性を含みます

フィールド

フィールド	型	説明	引数
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	非推奨: 使用しないでください
createdByUser	TDRUser

DeletedObject

フィールド

フィールド	型	説明	引数
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	非推奨: 使用しないでください
createdByUser	TDRUser

ConnectionVersionStrategy

説明: ConnectionVersionStrategyは新しいバージョンが公開された際の接続のアップグレード方法を決定します

Connection

説明: Connectionはテナントごとのコネクター／アクションの設定です

フィールド

フィールド	型	説明	引数
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	非推奨: 使用しないでください
createdByUser	TDRUser

ConnectionRateLimit

フィールド

フィールド	型	説明	引数
interval	String
limit	Int

Mutation

フィールド

フィールド	型	説明	引数
defineConnectionMethod	ConnectionMethod	新しい接続方式を定義	connectionMethod: ConnectionMethodInput
removeConnectionMethod	ConnectionMethod	接続方式を削除	connectorMethodId: ID
createConnector	Connector	新しいコネクターを作成	input: CreateConnectorInput
updateConnector	Connector	コネクター定義を更新	input: UpdateConnectorInput
deleteConnector	Connector	コネクターを削除	input: DeleteConnectorInput
cloneConnector	Connector	コネクターをクローン	input: CloneConnectorInput
importConnector	Connector	コネクターをインポート	input: ImportConnectorInput
deprecateConnector	Connector	コネクターを非推奨にする	input: DeprecateConnectorInput
undeprecateConnector	Connector	コネクターの非推奨を解除	input: UndeprecateConnectorInput
createConnectorVersion	ConnectorVersion	下書きモードで新しいコネクターバージョンを作成	connectorId: ID, input: CreateConnectorVersionInput
updateConnectorVersion	ConnectorVersion	既存の下書きコネクターバージョンを更新	input: UpdateConnectorVersionInput
publishConnectorVersion	ConnectorVersion	コネクターバージョンを公開すると不変となり、現在のheadとして設定されます	input: PublishConnectorVersionInput
deleteConnectorVersion	ConnectorVersion	コネクターバージョンの削除は、バージョン公開後はサポートされません	input: DeleteConnectorVersionInput
deprecateConnectorVersion	ConnectorVersion	コネクターバージョンを非推奨にする	input: DeprecateConnectorVersionInput
undeprecateConnectorVersion	ConnectorVersion	コネクターバージョンの非推奨を解除	input: UndeprecateConnectorVersionInput
createConnection	Connection	新しい接続を作成	connectorId: ID, connection: ConnectionInput
updateConnection	Connection	接続を更新	connectionId: ID, connection: ConnectionInput
updateConnectionV2	Connection	オプションフィールドで接続を更新します。 この更新はリクエストで送信されていないフィールドは更新しません。これはPATCHでありPUTではありません	input: UpdateConnectionInput
deleteConnection	Connection	接続を削除	connectionId: ID
validateConnection	Connection	既存の接続を検証	connectionId: ID
validateConnectionInput	Connector	新しい接続を検証	connectorId: ID, connection: ConnectionInput
executeConnectionAction	Any	アクションを実行	connectionId: ID, actionName: String, inputs: Any
testConnectorAction	Any	コネクターアクションをテスト	input: TestConnectorActionInput
executeConnectorAction	Any	コネクターアクションを実行	name: String, inputs: Any
verifyConnectorAction	Any	コネクターアクションをテスト	connectorId: ID, input: TestConnectorActionInput

ConnectionMethodInput

説明: ConnectionMethodInputは新しい接続方式を登録するために必要なフィールドを定義します

フィールド

フィールド	型	説明	引数
name	String
description	String
url	String
parameters	JSONSchema
tags	Tags

ConnectorActionInput

説明: ConnectorActionInputはコネクターアクション宣言の変更可能なフィールドを定義します

フィールド

フィールド	型	説明	引数
name	String
description	String
inputs	JSONSchema
outputs	JSONSchema
config	JSONObject

CreateConnectorInput

説明: ConnectorInputはコネクター作成に必要なフィールドを定義します

フィールド

フィールド	型	説明	引数
name	String
tags	Tags
icon	String
categories	IDs
method	ID
version	CreateConnectorVersionInput

UpdateConnectorInput

説明: UpdateConnectorInputはコネクターの変更可能なメタデータフィールドを定義します

フィールド

フィールド	型	説明	引数
connectorId	ID
tags	Tags
icon	String
categories	IDs
head	ID

DeleteConnectorInput

説明: DeleteConnectorInputはコネクターの変更可能なメタデータフィールドを定義します

フィールド

フィールド	型	説明	引数
connectorId	ID

ConnectorRateLimitInput

フィールド

フィールド	型	説明	引数
defaultInterval	String
defaultLimit	Int
maxInterval	String
maxLimit	Int
minInterval	String
minLimit	Int

CloneConnectorInput

フィールド

フィールド	型	説明	引数
name	String
connectorId	ID
versionId	ID
title	String	クローンしたコネクターの新しいタイトル（オプション）

CreateConnectorVersionInput

説明: CreateConnectorVersionInputはコネクターのバージョンフィールドを定義します

フィールド

フィールド	型	説明	引数
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

説明: UpdateConnectorVersionInputはコネクターのバージョンフィールドを定義します

フィールド

フィールド	型	説明	引数
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

説明: PublishConnectorVersionInput

フィールド

フィールド	型	説明	引数
connectorVersionId	ID
version	SemVer

DeleteConnectorVersionInput

説明: DeleteConnectorVersionInput

フィールド

フィールド	型	説明	引数
connectorVersionId	ID

ImportConnectorInput

フィールド

フィールド	型	説明	引数
file	Upload

DeprecateConnectorVersionInput

説明: DeprecateConnectorVersionInput

フィールド

フィールド	型	説明	引数
connectorVersionId	ID
deprecationReason	String

UndeprecateConnectorVersionInput

説明: UndeprecateConnectorVersionInput

フィールド

フィールド	型	説明	引数
connectorVersionId	ID

DeprecateConnectorInput

説明: DeprecateConnectorInput

フィールド

フィールド	型	説明	引数
connectorId	ID
deprecationReason	String

UndeprecateConnectorInput

説明: UndeprecateConnectorInput

フィールド

フィールド	型	説明	引数
connectorId	ID

TestConnectorActionInput

フィールド

フィールド	型	説明	引数
connection	ConnectionInput
connectionMethodName	String
action	ConnectorActionInput
inputs	Any

ConnectionRawAuth

フィールド

フィールド	型	説明	引数
value	String

ConnectionBasicAuth

フィールド

フィールド	型	説明	引数
username	String
password	String

ConnectionAPIKeyAuth

フィールド

フィールド	型	説明	引数
param	String
value	String
header	String

ConnectionOAuth2ClientCredsAuth

フィールド

フィールド	型	説明	引数
clientId	String
clientSecret	String
scopes	String

ConnectionClientCertificateAuth

フィールド

フィールド	型	説明	引数
certificate	String
privateKey	String
privateKeyPassword	String

ConnectionOAuth2PasswordCredsAuth

フィールド

フィールド	型	説明	引数
clientId	String
clientSecret	String
scopes	String
Username	String
Password	String

ConnectionOAuth2AuthCodeAuth

フィールド

フィールド	型	説明	引数
clientId	String
clientSecret	String
scopes	String
authCode	String

ConnectionCredentialsInput

フィールド

フィールド	型	説明	引数
rawAuth	ConnectionRawAuth
basicAuth	ConnectionBasicAuth
apiKeyAuth	ConnectionAPIKeyAuth
clientCredentialsAuth	ConnectionOAuth2ClientCredsAuth
clientCertificateAuth	ConnectionClientCertificateAuth
ownerPasswordCredentialsAuth	ConnectionOAuth2PasswordCredsAuth
authCodeAuth	ConnectionOAuth2AuthCodeAuth

ConnectorAuthDefaultsInput

説明: ConnectorAuthDefaultsInputは接続作成時に提案するデフォルト値を定義します。

フィールド

フィールド	型	説明	引数
url	String
basicAuth	ConnectionBasicAuth
apiKeyAuth	ConnectionAPIKeyAuth
clientCredentialsAuth	ConnectionOAuth2ClientCredsAuth
clientCertificateAuth	ConnectionClientCertificateAuth
ownerPasswordCredentialsAuth	ConnectionOAuth2PasswordCredsAuth
authCodeAuth	ConnectionOAuth2AuthCodeAuth

ConnectionInput

説明: ConnectionInputは接続の変更可能なフィールドを定義します

フィールド

フィールド	型	説明	引数
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

説明: UpdateConnectionInputは接続の変更可能なフィールドを定義します

フィールド

フィールド	型	説明	引数
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

ConnectionRateLimitInput

フィールド

フィールド	型	説明	引数
interval	String
limit	Int

ConnectorExport

フィールド

フィールド	型	説明	引数
export	String

Any

Time

説明: このライブラリのTime実装。

JSONSchema

説明: JSONスキーマ

JSONObject

説明: JSONペイロード

Tags

説明: タグのリスト

IDs

説明: IDのリスト

SemVer

説明: semver形式のバージョン文字列

Upload

RN

説明: リソース情報