Atlassian · Schema

Event

Represents an audit event that occurred within the organization, capturing actions such as user changes, policy updates, and access modifications.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string The unique identifier of the event.
type string The resource type.
attributes object The event attributes.
View JSON Schema on GitHub

JSON Schema

atlassian-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Event",
  "title": "Event",
  "type": "object",
  "description": "Represents an audit event that occurred within the organization, capturing actions such as user changes, policy updates, and access modifications.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the event.",
      "example": "abc123"
    },
    "type": {
      "type": "string",
      "description": "The resource type.",
      "enum": [
        "event"
      ],
      "example": "event"
    },
    "attributes": {
      "type": "object",
      "description": "The event attributes.",
      "properties": {
        "time": {
          "type": "string",
          "format": "date-time",
          "description": "When the event occurred."
        },
        "action": {
          "type": "string",
          "description": "The action that was performed."
        },
        "actor": {
          "type": "object",
          "description": "The entity that performed the action.",
          "properties": {
            "id": {
              "type": "string",
              "description": "The identifier of the actor."
            },
            "name": {
              "type": "string",
              "description": "The display name of the actor."
            },
            "type": {
              "type": "string",
              "description": "The type of actor.",
              "enum": [
                "user",
                "system",
                "app"
              ]
            },
            "links": {
              "type": "object",
              "properties": {
                "self": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          }
        },
        "context": {
          "type": "array",
          "description": "Contextual details about the event.",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "container": {
          "type": "array",
          "description": "Containers related to the event.",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            }
          }
        },
        "location": {
          "type": "object",
          "description": "Location information for the event.",
          "properties": {
            "ip": {
              "type": "string",
              "description": "IP address from which the event originated."
            },
            "geo": {
              "type": "string",
              "description": "Geographic location."
            }
          }
        }
      },
      "example": "example_value"
    }
  }
}