Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Audits

Update Audit

Use this API to update the approvers, attributes, and auditors of a specific audit.

put/api/audit-management/v1/audits/{auditId}

Path parameters

auditIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Audit identifier (UUID)

Request body

auditorAssignmentType'THROW_EXCEPTION_ON_AUDITOR_REMOVAL_IF_SCOPES_ASSIGNED' | 'UNASSIGN_SCOPES_ON_AUDITOR_REMOVAL' required
attributesobject

Custom Attributes

Example request

{
  "header": {
    "name": "Annual Security Compliance Audit",
    "auditTypeId": "123e4567-e89b-12d3-a456-426614174002",
    "goal": "To assess compliance with information security controls and identify areas for improvement",
    "startDate": "2025-06-01",
    "endDate": "2025-06-30"
  },
  "auditors": [
    {
      "email": "john.auditor@example.com"
    }
  ],
  "approvers": [
    {
      "email": "john.auditor@example.com"
    }
  ]
}

Response

OK

auditIdstring uuid

Audit Identifier

namestring

Audit Name

numberinteger

Audit Number

orgGroupIdstring uuid

Audit Organization Group Identifier

auditTypeIdstring uuid

Audit Type Identifier

auditTypestring

Audit Type

auditTypeNameKeystring

Translation key for the audit type name used for localization

goalstring

The goal of the Audit.

startDatestring date

Audit Start Date

endDatestring date

Audit End Date

orgGroupstring

Audit Organization Group

lastModifiedDatestring date-time

Date when the audit was last modified

attributesobject

Custom Attributes

Example response

{
  "auditId": "25ce2fe7-aece-4f0d-a216-c189b1d1aac4",
  "name": "Annual Security Assessment 2025",
  "number": 10023,
  "orgGroupId": "b7d17fc8-889f-472e-8c74-f1169821e7e7",
  "auditTypeId": "123e4567-e89b-12d3-a456-426614174002",
  "auditType": "Security Audit",
  "auditTypeNameKey": "audit.type.security",
  "goal": "To assess compliance with security controls and identify areas for improvement",
  "frameworks": [
    {
      "id": "df4a5bb9-e733-4e90-83f6-7efa00fac5b9",
      "name": "NIST Cybersecurity Framework"
    }
  ],
  "startDate": "2025-06-01",
  "endDate": "2025-06-30",
  "orgGroup": "Finance Department",
  "auditors": [
    {
      "id": "df4a5bb9-e733-4e90-83f6-7efa00fac5b9",
      "name": "John Doe"
    }
  ],
  "approvers": [
    {
      "id": "df4a5bb9-e733-4e90-83f6-7efa00fac5b9",
      "name": "Jane Doe"
    }
  ],
  "workflow": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "In Progress",
    "nameKey": "workflow.stage.in_progress"
  },
  "stage": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Security Entity",
    "nameKey": "workflow.stage.in_progress",
    "badgeColor": "blue"
  },
  "lastModifiedDate": "2025-06-15T14:30:00Z",
  "attributes": {
    "attributeTextValue.value1": [
      {
        "id": null,
        "value": "Critical",
        "valueKey": null
      }
    ]
  }
}