Atlassian · Schema

AuditRecord

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
author object
remoteAddress string
creationDate integer The creation date-time of the audit record, as a timestamp.
summary string
description string
category string
sysAdmin boolean
superAdmin boolean
affectedObject object
changedValues array
associatedObjects array
View JSON Schema on GitHub

JSON Schema

atlassian-auditrecord-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuditRecord",
  "title": "AuditRecord",
  "required": [
    "affectedObject",
    "associatedObjects",
    "author",
    "category",
    "changedValues",
    "creationDate",
    "description",
    "remoteAddress",
    "summary",
    "sysAdmin"
  ],
  "type": "object",
  "properties": {
    "author": {
      "required": [
        "displayName",
        "operations",
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "default": "user",
          "enum": [
            "user"
          ]
        },
        "displayName": {
          "type": "string"
        },
        "operations": {
          "nullable": true,
          "type": "object",
          "properties": {}
        },
        "username": {
          "$ref": "#/components/schemas/GenericUserName"
        },
        "userKey": {
          "$ref": "#/components/schemas/GenericUserKey"
        },
        "accountId": {
          "$ref": "#/components/schemas/GenericAccountId"
        },
        "accountType": {
          "type": "string"
        },
        "externalCollaborator": {
          "type": "boolean"
        },
        "isExternalCollaborator": {
          "type": "boolean",
          "description": "Whether the user is an external collaborator user"
        },
        "publicName": {
          "type": "string",
          "description": "The public name or nickname of the user. Will always contain a value."
        }
      }
    },
    "remoteAddress": {
      "type": "string"
    },
    "creationDate": {
      "type": "integer",
      "description": "The creation date-time of the audit record, as a timestamp.",
      "format": "int64"
    },
    "summary": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "category": {
      "type": "string"
    },
    "sysAdmin": {
      "type": "boolean"
    },
    "superAdmin": {
      "type": "boolean"
    },
    "affectedObject": {
      "$ref": "#/components/schemas/AffectedObject"
    },
    "changedValues": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChangedValue"
      }
    },
    "associatedObjects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AffectedObject"
      }
    }
  }
}