Audit

This contains APIs related to Audit as defined in Harness

List Audit Events

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

pageIndex
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

pageSize
integer <int32> <= 100
Default: 50

Results per page(max 100)Default Value: 50

Array of objects (SortOrder)

Sort criteria for the elements.

Request Body schema:

This has the filter attributes for listing Audit Events

Array of objects (AuditResourceScope)

List of Resource Scopes

Array of objects (AuditResource)

List of Resources

modules
Array of strings

List of Module Types

Items Enum: "CD" "CI" "CV" "CF" "CE" "STO" "CORE" "PMS" "TEMPLATESERVICE" "GOVERNANCE" "CHAOS"
actions
Array of strings

List of Actions

Items Enum: "CREATE" "UPDATE" "RESTORE" "DELETE" "UPSERT" "INVITE" "RESEND_INVITE" "REVOKE_INVITE" "ADD_COLLABORATOR" "REMOVE_COLLABORATOR" "CREATE_TOKEN" "REVOKE_TOKEN" "LOGIN" "LOGIN2FA" "UNSUCCESSFUL_LOGIN" "ADD_MEMBERSHIP" "REMOVE_MEMBERSHIP" "ERROR_BUDGET_RESET"
Array of objects (Environment)

List of Environments

Array of objects (AuditPrincipal)

List of Principals

staticFilter
string

Pre-defined Filter

Enum: "EXCLUDE_LOGIN_EVENTS" "EXCLUDE_SYSTEM_EVENTS"
startTime
integer <int64>

Used to specify a start time for retrieving Audit events that occurred at or after the time indicated.

endTime
integer <int64>

Used to specify the end time for retrieving Audit events that occurred at or before the time indicated.

object

Filter tags as a key-value pair.

filterType
required
string

This specifies the corresponding Entity of the filter.

Enum: "Connector" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment"
Responses
400

Bad Request

500

Internal server error

default

This has a paginated list of Audit Events.

post/audit/api/audits/list
Request samples
{
  • "scopes": [
    ],
  • "resources": [
    ],
  • "modules": [
    ],
  • "actions": [
    ],
  • "environments": [
    ],
  • "principals": [
    ],
  • "staticFilter": "EXCLUDE_LOGIN_EVENTS",
  • "startTime": 0,
  • "endTime": 0,
  • "tags": {
    },
  • "filterType": "Connector"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}