BYOTI GraphQL API

Time

説明: TimeはRFC3339形式のタイムスタンプです

Mutation

説明: お客様の脅威インテリジェンスデータの取り込みや変更を行うためのミューテーション

フィールド

フィールド	型	説明	引数
upsertSTIXDocuments	UpsertIndicatorsResponse	インジケーターとしてSTIXドキュメントを追加または更新するためのミューテーション	input: STIXDocumentInput
upsertIndicators	UpsertIndicatorsResponse	インジケーターを追加または更新するためのミューテーション	input: IndicatorInput
deleteIndicators	DeleteIndicatorResponse	CQLクエリを使用してインジケーターを削除するためのミューテーション	query: String

String

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

Query

説明: お客様の脅威インテリジェンスデータの検索をサポートするクエリ

フィールド

フィールド	型	説明	引数
searchIndicators	SearchIndicatorsResponse	Taegis QLを使用してインジケーターを検索するためのクエリ	input: SearchIndicatorsInput
getIndicators	SearchIndicatorsResponse	APIを使用してインジケーターを検索するクエリ。getIndicatorsは、指定された検索パラメータに基づいてインジケーターを検索し返します。パラメータが空の場合、呼び出し元に属する任意のインジケーターを1ページあたりデフォルトで100件まで返します	input: GetIndicatorsInput
paginateIndicators	SearchIndicatorsResponse	PaginateIndicatorsはgetIndicatorsと似ていますが、カーソルベースのページネーションを使用します	input: PaginateIndicatorsInput

SearchIndicatorsInput

説明: SearchIndicatorsクエリへの入力

フィールド

フィールド	型	説明	引数
query	String	インジケーターの検索に使用するTaegis QLクエリ
page	Int	取得するページを指定
per_page	Int	1ページあたりのインジケーター数を指定
with_partner_tenants	Boolean	呼び出し元に属する追加テナントを含める

Int

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

Boolean

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

STIXDocumentInput

説明: ミューテーションへの入力として使用されるSTIXドキュメントを表します

フィールド

フィールド	型	説明	引数
type	String	現在サポートされているタイプは 'indicator'
spec_version	String	STIXインジケーターの現在サポートされているバージョンは '2.1'
id	ID	ソースからの一意の識別子。一般的にstixの'ID'
created	Time	無視されます
modified	Time	無視されます
name	String	インジケーターを説明する名前
description	String	インジケーターの説明
pattern	String	PatternはSTIX形式のインジケーターパターン
pattern_type	String	現在サポートされているpattern_typeは 'stix'
severity	Severity	SeverityはINFO、LOW、MEDIUM、HIGH、CRITICALを受け付けます
source_name	String	インジケーターを提供するソースの名前
integration_id	Int	インジケーターを取り込んだインテグレーションのID
reference_url	String	インジケーターを説明するURL
valid_from	Time	valid_fromはインジケーターが有効となる時刻を設定します

ID

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

ObjectType

説明: ObjectTypeはインジケーターのタイプです

可能な値

• DOMAIN = "domain"
• HASH = "hash"
• IP = "ip"
• URL = "url"

ObjectSubtype

説明: インジケーターのサブタイプ

可能な値

• ObjectTypeがIPの場合:
  • IPV4 = "ipv4"
  • IPV6 = "ipv6"
• ObjectTypeがHASHの場合:
  • MD5 = "md5"
  • SHA1 = "sha1"
  • SHA256 = "sha256"

Severity

説明: インジケーターによって作成されるアラートの重大度を示す値を定義します

可能な値

• INFO = "INFO"
• LOW = "LOW"
• MEDIUM = "MEDIUM"
• HIGH = "HIGH"
• CRITICAL = "CRITICAL"

ByotiIndicator

説明: APIに保存されているインジケーターの表現

フィールド

フィールド	型	説明	引数
id	ID	インジケーターの内部ID
object_type	ObjectType	object_type列挙型で定義されたインジケーターのタイプ
object_subtype	ObjectSubtype	object_subtype列挙型で定義されたインジケーターのサブタイプ
name	String	インジケーターを説明する名前
description	String	インジケーターの説明
tenant_id	ID	インジケーター記録を管理するテナントのID
value	String	生のインジケーター
reference_url	String	インジケーターを説明する外部URL
severity	Severity	severity列挙型のいずれかの重大度値
source_name	String	インジケーターが取得されたデータソース
integration_id	Int	インジケーターを取り込んだインテグレーションのID
created_at	Time	インジケーターがAPIで作成された日時
updated_at	Time	インジケーターがAPIで更新された日時
deleted_at	Time	インジケーターがAPIで削除された日時

ByotiRejectedIndicatorResponse

説明: 拒否されたインジケーターと拒否理由

フィールド

フィールド	型	説明	引数
value	String	生のインジケーター
reason	String	インジケーターが拒否された理由

UpsertIndicatorsResponse

説明: インジケーターの作成または更新を担当するミューテーションのレスポンスタイプ

フィールド

フィールド	型	説明	引数
accepted_indicators	ByotiIndicator	APIによって受け入れられたインジケーター
rejected_indicators	ByotiRejectedIndicatorResponse	APIによって拒否されたインジケーター

SearchIndicatorsResponse

説明: SearchIndicatorsクエリのレスポンスタイプ

フィールド

フィールド	型	説明	引数
indicators	ByotiIndicator	クエリに対して返されたインジケーターのリスト
page	Int	返されたページ番号
per_page	Int	この検索で1ページあたりのインジケーターの最大数
offset	Int	内部オフセット
total_pages	Int	指定されたページ数に基づく結果の総ページ数
current_entries_returned	Int	このページで返されたエントリー数
total_entries_size	Int	検索条件に一致するエントリーの総数
cursor	String	結果のページネーションに使用

GetIndicatorsInput

説明: 指定されたフィールドに一致するインジケーターを取得

フィールド

フィールド	型	説明	引数
object_type	ObjectType	オブジェクトタイプでインジケーターをフィルタ
updated_after	Time	updated_at >= updated_after で返されるインジケーターをフィルタするためのタイムスタンプを指定
with_partner_tenants	Boolean	呼び出し元に属する追加テナントを含める
reference_url	String	インジケーターに関するデータを説明するURL
source_name	String	インジケーターのソース名
integration_id	Int	インジケーターを取り込んだインテグレーションのID
severity	Severity	INFO、LOW、MEDIUM、HIGH、CRITICAL形式のインジケーターの重大度
exclude_deleted	Boolean	削除されたインジケーターを除外
page	Int	取得するページを指定
per_page	Int	1ページあたりのインジケーター数を指定

PaginateIndicatorsInput

説明: 指定されたフィールドに一致するインジケーターをページネーション

フィールド

フィールド	型	説明	引数
object_type	ObjectType	オブジェクトタイプでインジケーターをフィルタ
updated_after	Time	updated_at >= updated_after で返されるインジケーターをフィルタするためのタイムスタンプを指定
with_partner_tenants	Boolean	呼び出し元に属する追加テナントを含める
reference_url	String	インジケーターに関するデータを説明するURL
source_name	String	インジケーターのソース名
integration_id	Int	インジケーターを取り込んだインテグレーションのID
severity	Severity	INFO、LOW、MEDIUM、HIGH、CRITICAL形式のインジケーターの重大度
exclude_deleted	Boolean	削除されたインジケーターを除外
per_page	Int	取得するページを指定
cursor	String	結果のページネーションに使用するカーソル。最初のリクエスト時は空にし、それ以降はレスポンスで返された値を使用

IndicatorInput

説明: UpsertIndicatorsミューテーションへの入力として使用

フィールド

フィールド	型	説明	引数
object_type	ObjectType	現在サポートされているオプション: ip, hash, domain, url
object_subtype	ObjectSubtype	object_typeに依存するサブタイプ
name	String	脅威インジケーターのわかりやすい名前
description	String	インジケーターの説明
value	String	インジケーターの値
reference_url	String	インジケーターに関するデータを説明するURL
source_name	String	インジケーターのソース名
integration_id	Int	インジケーターを取り込んだインテグレーションのID
severity	Severity	INFO、LOW、MEDIUM、HIGH、CRITICAL形式のインジケーターの重大度

DeleteIndicatorResponse

説明: DeleteIndicatorsミューテーションのレスポンスタイプ

フィールド

フィールド	型	説明	引数
indicators	ByotiIndicator	削除対象としてマークされたインジケーターのリスト
status	Boolean	ステータス true または false