Retrieve account records

11/28/2024 Contributors

GET /audit/{accountId}

Retrieves account records by a specified account public ID.

Token usage: BlueXP user token.

Parameters

Name	Type	In	Required
accountId	string	path	True
fromLastModified	number	query	False
toLastModified	number	query	False
fromStartTime	number	query	False
qAction	string	query	False
qService	string	query	False
qStatus	string	query	False
qAgent	string	query	False
qResource	string	query	False
qUser	string	query	False
toStartTime	number	query	False
offset	number	query	False

Name

Type

Required

Description

accountId

string

path

True

fromLastModified

number

query

False

toLastModified

number

query

False

fromStartTime

number

query

False

qAction

string

query

False

qService

string

query

False

qStatus

string

query

False

qAgent

string

query

False

qResource

string

query

False

qUser

string

query

False

toStartTime

number

query

False

offset

number

query

False

Response

Status: 200,

List of GetAuditGroupResDto

Definitions

See Definitions

GetAuditGroupResDto

Name	Type	Required	Description
accountId	string	True
startTime	number	True	The start time of the event. Unix epoch in milliseconds
endTime	number	True	The start time of the event. Unix epoch in milliseconds
action	string	True	Action name of the event.
status	string	True	Status of the operation.
requestId	string	True	RequestId of the operation. globally unique for the service.
service	string	True	Service in which the operation was performed.
principalId	string	True	Id of the entity performing the operation.
agentName	string	False	Name of the agent which performed the operation.
agentId	string	False	Id of the agent which performed the operation.
resourceName	string	False	Name of the resource acted upon by the operation.
resourceId	string	False	Id of the resource acted upon by the operation.
errors	array[string]	False	Array of error message/s if exists. that related to this auditGroup
requestData	string	False	Parameters related to request of operation. a string, can be JSON string
responseData	string	False	Response of the operation. Must be a string, can be JSON in a string.
workspaceId	string	False	Id of the workspace in which the resource is contained.
hasRecords	boolean	True
hasFailedRecord	boolean	True
lastModified	number	True	Last modified time. Unix epoch in milliseconds

Name

Type

Required

Description

accountId

string

True

startTime

number

True

The start time of the event. Unix epoch in milliseconds

endTime

number

True

The start time of the event. Unix epoch in milliseconds

action

string

True

Action name of the event.

status

string

True

Status of the operation.

requestId

string

True

RequestId of the operation. globally unique for the service.

service

string

True

Service in which the operation was performed.

principalId

string

True

Id of the entity performing the operation.

agentName

string

False

Name of the agent which performed the operation.

agentId

string

False

Id of the agent which performed the operation.

resourceName

string

False

Name of the resource acted upon by the operation.

resourceId

string

False

Id of the resource acted upon by the operation.

errors

array[string]

False

Array of error message/s if exists. that related to this auditGroup

requestData

string

False

Parameters related to request of operation. a string, can be JSON string

responseData

string

False

Response of the operation. Must be a string, can be JSON in a string.

workspaceId

string

False

Id of the workspace in which the resource is contained.

hasRecords

boolean

True

hasFailedRecord

boolean

True

lastModified

number

True

Last modified time. Unix epoch in milliseconds

Retrieve account records

Parameters

Response

Definitions

Parameters

Headers

Body

Code

Response