Method: legacySoarAudit.legacyGetAuditDataV2

Full name: projects.locations.instances.legacySoarAudit.legacyGetAuditDataV2

Gets the audit data.

HTTP request


Path parameters

Parameters
instance

string

Required. The name of the parent resource, which is the SecOps instance. Format: projects/{project}/locations/{location}/instances/{instance}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageNumber": integer,
  "usersNames": [
    string
  ],
  "apiKeys": [
    string
  ],
  "auditSettingsRequestType": enum (AuditSettingsRequestTypeEnum)
}
Fields
pageNumber

integer

Optional. The page number of the audit data.
usersNames[]

string

Optional. The users names to get the audit data for.
apiKeys[]

string

Optional. The api keys to get the audit data for.
auditSettingsRequestType

enum (AuditSettingsRequestTypeEnum)

Optional. The type of the audit request.

Response body

Response message for LegacySoarAuditService

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": {
    object (AuditSettingsResponse)
  }
}
Fields
payload

object (AuditSettingsResponse)

Required. The AuditSettingsResponse response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AuditSettingsRequestTypeEnum

Enum that represents the type of the audit settings request.

Enums
GROUP Group.
COUNT Count.

AuditSettingsResponse

Message that represents a audit settings response.

JSON representation 
{
  "auditRecords": [
    {
      object (AuditData)
    }
  ],
  "operationsDistribution": [
    {
      object (CountData)
    }
  ],
  "mostCommonOperations": [
    {
      object (CountData)
    }
  ],
  "mostCommonResulations": [
    {
      object (CountData)
    }
  ],
  "mostCommonActiveUsers": [
    {
      object (MostActiveUsersCountData)
    }
  ],
  "mostCommonBrowsers": [
    {
      object (CountData)
    }
  ],
  "mostCommonAddresses": [
    {
      object (CountData)
    }
  ],
  "totalCount": integer,
  "pageSize": integer,
  "pageNumber": integer,
  "auditSettingsRequestType": enum (AuditSettingsRequestTypeEnum)
}
Fields
auditRecords[]

object (AuditData)

Optional. Audit records.
operationsDistribution[]

object (CountData)

Optional. Operations distribution.
mostCommonOperations[]

object (CountData)

Optional. Most common operations.
mostCommonResulations[]

object (CountData)

Optional. Most common regulations.
mostCommonActiveUsers[]

object (MostActiveUsersCountData)

Optional. Most common active users.
mostCommonBrowsers[]

object (CountData)

Optional. Most common browsers.
mostCommonAddresses[]

object (CountData)

Optional. Most common addresses.
totalCount

integer

Optional. Total count.
pageSize

integer

Optional. Page size.
pageNumber

integer

Optional. Page number.
auditSettingsRequestType

enum (AuditSettingsRequestTypeEnum)

Optional. Audit settings request type.

AuditSettingsRequestTypeEnum

Enum that represents the type of the audit settings request.

Enums
GROUP Group.
COUNT Count.

AuditData

Message that represents an audit data.

JSON representation 
{
  "user": string,
  "userGuid": string,
  "module": string,
  "operation": string,
  "address": string,
  "browser": string,
  "screenSize": string,
  "activityItem": string,
  "currentActivity": string,
  "previousActivity": string,
  "source": string
}
Fields
user

string

The user name is audited.
userGuid

string

Optional. The user guid.
module

string

Optional. The module.
operation

string

Optional. The operation.
address

string

The address.
browser

string

The browser.
screenSize

string

The screen size.
activityItem

string

The activity item.
currentActivity

string

Optional. The current activity.
previousActivity

string

Optional. The previous activity.
source

string

The source.

CountData

Message that represents a count data.

JSON representation 
{
  "name": string,
  "count": integer,
  "countLabel": string
}
Fields
name

string

The name.
count

integer

Optional. The count.
countLabel

string

Optional. The count label.

MostActiveUsersCountData

Message that represents a most active users count data.

JSON representation 
{
  "userFullName": string,
  "name": string,
  "count": integer,
  "countLabel": string
}
Fields
userFullName

string

The user full name.
name

string

Name of the user.
count

integer

Optional. The count.
countLabel

string

Optional. The count label.