REST Resource: organizations.locations.auditSchedules

Resource: AuditSchedule

An audit schedule, in one of the following formats:

  • projects/{project}/locations/{location}/auditSchedules/{auditSchedule}
  • folders/{folder}/locations/{location}/auditSchedules/{auditSchedule}
  • organizations/{organization}/locations/{location}/auditSchedules/{auditSchedule}
JSON representation 
{
  "name": string,
  "displayName": string,
  "gcsUri": string,
  "complianceFramework": string,
  "reportFormat": enum (AuditReportFormat),
  "scheduleConfig": {
    object (ScheduleConfig)
  },
  "state": enum (ScheduleState),
  "createTime": string,
  "updateTime": string,
  "nextRunTime": string,
  "lastTriggerTime": string,
  "errorMessage": string
}
Fields
name

string

Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{auditSchedule} folders/{folder}/locations/{location}/auditSchedules/{auditSchedule} organizations/{organization}/locations/{location}/auditSchedules/{auditSchedule}
displayName

string

Optional. Display name for the audit schedule.
gcsUri

string

Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is gs://{bucket_name}.
complianceFramework

string

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.
reportFormat

enum (AuditReportFormat)

Required. Format for the audit report.
scheduleConfig

object (ScheduleConfig)

Required. Configuration that defines when and how often audit runs are automatically triggered for this schedule.
state

enum (ScheduleState)

Optional. State of the audit schedule. While most states are managed by the system, you can use auditSchedules.patch to start, pause, or delete the schedule.
createTime

string (Timestamp format)

Output only. Timestamp when the schedule was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp when the schedule was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
nextRunTime

string (Timestamp format)

Output only. Calculated timestamp for the next scheduled run.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastTriggerTime

string (Timestamp format)

Output only. Timestamp when the audit run was last triggered.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
errorMessage

string

Output only. Describes the error if the schedule is in an error state.

Methods

create

 Creates a new audit schedule in a given organization and location.

get

 Gets details of a single audit schedule.

list

 Lists audit schedules in a given organization and location.

patch

 Updates an existing audit schedule.