Audits GraphQL API

Query

Fields

Field	Type	Description	Arguments
node	Node		id: ID
audit	Audit	Get an audit by id	AuditID: ID
allAudits	AuditResult	Get all audits	allAuditsInput: AllAuditsInput
searchAudits	AuditResult	Search audits	auditSearchInput: AuditSearchInput
ListApplicationEvents	AuditEventResult	Get event name list	application: AuditEventEnum
aggregateByApplications	ApplicationAggregationResult	Aggregate By Applications	aggregationInput: ApplicationAggregationInput, auditSearchInput: AuditSearchInput

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.

Mutation

Description: GraphQL Mutations

Fields

Field	Type	Description	Arguments
createAudit	Audit	Create a new audit log	audit: AuditInput

Int64

Description: A scalar for 64 bit integers

Node

Fields

Field	Type	Description	Arguments
id	ID

Subject

Fields

Field	Type	Description	Arguments
id	ID

Audit

Description: Defines the fields of an Audit log

Fields

Field	Type	Description	Arguments
id	ID
logType	String
application	String
requestType	String
username	String
email	String
subject	Subject
token	Map
source	String
targetRn	String
action	String
timestamp	Time
eventName	String
eventDesc	String
tenantId	String
traceId	ID
metadata	MetadataMap
responseCode	Int
url	String
headers	HeaderMap
requestParams	RequestParamMap
beforeState	Map
afterState	Map
extras	Map
ccdpStatus	String
partnerInternalLog	Boolean

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.

Int

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

Boolean

Description: The Boolean scalar type represents true or false.

AuditResult

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

Fields

Field	Type	Description	Arguments
totalResults	Int
relation	String
offset	Int
limit	Int
audits	Audit

AuditInput

Description: Internal use only - Defines the fields of an audit log

Fields

Field	Type	Description	Arguments
logType	String
application	String
requestType	String
actor	String
actorName	String
actorEmail	String
token	Map
source	String
targetRn	String
action	String
tenantId	String
eventName	String
eventNameIndex	Int
eventDesc	String
traceId	ID
metadata	MetadataMap
responseCode	Int
url	String
headers	HeaderMap
requestParams	RequestParamMap
beforeState	Map
afterState	Map
extras	Map
partnerInternalLog	Boolean

AllAuditsInput

Description: Defines the fields for retrieving paginated Audit logs. When specifying tenants to include, 'tenantIDs' takes precedence, followed by 'sessionID', and finally the 'X-Tenant-Context' header if neither of those are included. 'sessionID' selects a multi-tenant context session, and may be set to an empty string to select the default global session. Multiple comma-separated tenant IDs may be included in 'X-Tenant-Context' headers.

Fields

Field	Type	Description	Arguments
tenantIDs	String
sessionID	String
offset	Int
limit	Int
before	Time
after	Time
sortBy	SortBy
sortOrder	SortOrder

AuditSearchInput

Description: Defines the fields used for searching Audit logs along with pagination input like offset and limit. When specifying tenants to search, 'tenantIDs' takes precedence, followed by 'sessionID', and finally the 'X-Tenant-Context' header if neither of those are included. 'sessionID' selects a multi-tenant context session, and may be set to an empty string to select the default global session. Multiple comma-separated tenant IDs may be included in 'X-Tenant-Context' headers.

Fields

Field	Type	Description	Arguments
tenantIDs	String
sessionID	String
offset	Int
limit	Int
id	String
logType	String
application	String
applications	String
requestType	String
username	String
email	String
emails	String
source	String
targetRn	String
targetRns	String
action	String
eventName	String
eventNames	String
eventDesc	String
traceId	String
url	String
searchByAll	String
before	Time
after	Time
sortBy	SortBy
sortOrder	SortOrder

ApplicationAggregationInput

Fields

Field	Type	Description	Arguments
intervalType	IntervalType
timeZone	String
applications	String

ApplicationAggregationResult

Fields

Field	Type	Description	Arguments
intervals	IntervalBucket
timeZone	String

IntervalBucket

Fields

Field	Type	Description	Arguments
intervalKeyInMills	Int64
intervalKey	Time
totalCount	Int
applicationMetrics	ApplicationMetric

ApplicationMetric

Fields

Field	Type	Description	Arguments
applicationName	String
count	Int

IntervalType

SortBy

SortOrder

AuditEventEnum

Description: Defines the types of AuditEvent

AuditEvent

Description: Defines the attributes of an Audit Event

Fields

Field	Type	Description	Arguments
name	String
desc	String

AuditEventResult

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

Fields

Field	Type	Description	Arguments
totalEvents	Int
auditEvents	AuditEvent

Time

Description: Default time implementation for this library.

Map

MetadataMap

HeaderMap

RequestParamMap