🌙
 

Subscribe to the Taegis™ XDR Documentation RSS Feed at .

Learn more about RSS readers or RSS browser extensions.

On this page:

Note

At this time, the Secureworks® Taegis™ XDR Audits API is read-only. There are currently no mutations available that allow you to send or push data.

Query

Field

node Type: Node

Arguments
id Type: ID!
Field

audit Type: Audit

Get an audit by id

Arguments
AuditID Type: ID!
Field

allAudits Type: AuditResult

Get all audits

Arguments
allAuditsInput Type: AllAuditsInput
Field

searchAudits Type: AuditResult

Search audits

Arguments
auditSearchInput Type: AuditSearchInput!
Field

ListApplicationEvents Type: AuditEventResult

Get event name list

Arguments
application Type: AuditEventEnum!

Objects

Audit

Defines the fields of an Audit log

Field

id Type: ID!

Field

logType Type: String!

Field

application Type: String!

Field

requestType Type: String!

Field

username Type: String!

Field

email Type: String!

Field

token Type: Map!

Field

source Type: String!

Field

targetRn Type: String

Field

action Type: String!

Field

timestamp Type: Time

Field

eventName Type: String!

Field

eventDesc Type: String!

Field

tenantId Type: String!

Field

traceId Type: ID

Field

metadata Type: MetadataMap

Field

responseCode Type: Int!

Field

url Type: String!

Field

headers Type: HeaderMap

Field

requestParams Type: RequestParamMap

Field

beforeState Type: Map

Field

afterState Type: Map

Field

extras Type: Map

AuditEvent

Defines the attributes of an Audit Event

Field

name Type: String!

Field

desc Type: String!

AuditEventResult

AuditEventResult represents a list of AuditEvents along with metadata like total events

Field

totalEvents Type: Int!

Field

auditEvents Type: [AuditEvent!]!

AuditResult

AuditResult represents a list of Audit logs along with metadata for pagination and relation

Field

totalResults Type: Int!

Field

relation Type: String!

Field

offset Type: Int!

Field

limit Type: Int!

Field

audits Type: [Audit!]!

Inputs

AllAuditsInput

Defines the fields for retrieving paginated Audit logs

Field

offset Type: Int

Field

limit Type: Int

Field

before Type: Time

Field

after Type: Time

Field

sortBy Type: SortBy

Field

sortOrder Type: SortOrder

AuditInput

Internal use only - Defines the fields of an audit log

Field

logType Type: String!

Field

application Type: String!

Field

requestType Type: String!

Field

actor Type: String!

Field

token Type: Map!

Field

source Type: String!

Field

targetRn Type: String

Field

action Type: String!

Field

tenantId Type: String!

Field

eventNameIndex Type: Int!

Field

eventDesc Type: String

Field

traceId Type: ID

Field

metadata Type: MetadataMap

Field

responseCode Type: Int!

Field

url Type: String!

Field

headers Type: HeaderMap

Field

requestParams Type: RequestParamMap

Field

beforeState Type: Map

Field

afterState Type: Map

Field

extras Type: Map

AuditSearchInput

Defines the fields used for searching Audit logs along with pagination input like offset and limit

Field

offset Type: Int

Field

limit Type: Int

Field

id Type: String

Field

logType Type: String

Field

application Type: String

Field

requestType Type: String

Field

username Type: String

Field

email Type: String

Field

source Type: String

Field

targetRn Type: String

Field

action Type: String

Field

eventName Type: String

Field

eventDesc Type: String

Field

traceId Type: String

Field

url Type: String

Field

searchByAll Type: String

Field

before Type: Time

Field

after Type: Time

Field

sortBy Type: SortBy

Field

sortOrder Type: SortOrder

Enums

AuditEventEnum

Defines the types of AuditEvent

investigations

alerts

SortBy

Defines fields that may be used to sort AuditResults

timestamp

application

eventName

eventDesc

username

email

SortOrder

Defines the fields that may be used to order the results in ascending or descending order

asc

desc

Scalars

Boolean

The Boolean scalar type represents true or false.

HeaderMap

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.

Int

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

Map

MetadataMap

RequestParamMap

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.

Time

Default time implementation for this library.

Interfaces

Node

Field

id Type: ID!