AuditEventCollectionResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-audit-event-collection-response-schema.json",
  "title": "AuditEventCollectionResponse",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-admin-audit-events-api-openapi.yml#/components/schemas/AuditEventCollectionResponse",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AuditEvent"
      },
      "description": "An array of audit event objects. See [this article](https://help.webex.com/n3b0w6x/) for details about each event type."
    }
  },
  "$defs": {
    "AdminRolesEnum": {
      "type": "string",
      "enum": [
        "User",
        "Full_Admin",
        "id_full_admin"
      ]
    },
    "AuditEvent": {
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "properties": {
            "actorOrgName": {
              "type": "string",
              "description": "The display name of the organization."
            },
            "targetName": {
              "type": "string",
              "description": "The name of the resource being acted upon."
            },
            "eventDescription": {
              "type": "string",
              "description": "A description for the event."
            },
            "actorName": {
              "type": "string",
              "description": "The name of the person who performed the action."
            },
            "actorEmail": {
              "type": "string",
              "description": "The email of the person who performed the action."
            },
            "adminRoles": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/AdminRolesEnum"
              },
              "description": "Admin roles for the person."
            },
            "trackingId": {
              "type": "string",
              "description": "A tracking identifier for the event."
            },
            "targetType": {
              "type": "string",
              "description": "The type of resource changed by the event."
            },
            "targetId": {
              "type": "string",
              "description": "The identifier for the resource changed by the event."
            },
            "eventCategory": {
              "type": "string",
              "description": "The category of resource changed by the event."
            },
            "actorUserAgent": {
              "type": "string",
              "description": "The browser user agent of the person who performed the action."
            },
            "actorIp": {
              "type": "string",
              "description": "The IP address of the person who performed the action."
            },
            "targetOrgId": {
              "type": "string",
              "description": "The `orgId` of the organization."
            },
            "actionText": {
              "type": "string",
              "description": "A more detailed description of the change made by the person."
            },
            "targetOrgName": {
              "type": "string",
              "description": "The name of the organization being acted upon."
            },
            "errorMessage": {
              "type": "string",
              "description": "User operation failure message."
            },
            "errorCode": {
              "type": "string",
              "description": "User operation failure code."
            }
          }
        },
        "created": {
          "type": "string",
          "description": "The date and time the event took place."
        },
        "actorOrgId": {
          "type": "string",
          "description": "The `orgId` of the person who made the change."
        },
        "id": {
          "type": "string",
          "description": "A unique identifier for the event."
        },
        "actorId": {
          "type": "string",
          "description": "The `personId` of the person who made the change."
        }
      }
    }
  }
}