{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AuditEvent",
"title": "AuditEvent",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"actorOrgName": {
"type": "string",
"example": "Acme Inc.",
"description": "The display name of the organization."
},
"targetName": {
"type": "string",
"example": "Acme Inc.",
"description": "The name of the resource being acted upon."
},
"eventDescription": {
"type": "string",
"example": "An Admin logged in",
"description": "A description for the event."
},
"actorName": {
"type": "string",
"example": "Joe Smith",
"description": "The name of the person who performed the action."
},
"actorEmail": {
"type": "string",
"example": "[email protected]",
"description": "The email of the person who performed the action."
},
"adminRoles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminRolesEnum"
},
"description": "Admin roles for the person."
},
"trackingId": {
"type": "string",
"example": "ATLAS_6f23a878-bcd4-c204-a4db-e701b42b0e5c_0",
"description": "A tracking identifier for the event."
},
"targetType": {
"type": "string",
"example": "TargetResourceType.ORG",
"description": "The type of resource changed by the event."
},
"targetId": {
"type": "string",
"example": "NWIzZTBiZDgtZjg4Ni00MjViLWIzMTgtYWNlYjliN2EwZGFj",
"description": "The identifier for the resource changed by the event."
},
"eventCategory": {
"type": "string",
"example": "EventCategory.LOGINS",
"description": "The category of resource changed by the event."
},
"actorUserAgent": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who performed the action."
},
"actorIp": {
"type": "string",
"example": "128.107.241.191",
"description": "The IP address of the person who performed the action."
},
"targetOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The `orgId` of the organization."
},
"actionText": {
"type": "string",
"example": "Joe Smith logged into organization Acme Inc.",
"description": "A more detailed description of the change made by the person."
},
"targetOrgName": {
"type": "string",
"example": "Acme Inc.",
"description": "The name of the organization being acted upon."
},
"errorMessage": {
"type": "string",
"example": "WXC-25058 Extension cannot be less than 2 or greater than 6 characters",
"description": "User operation failure message."
},
"errorCode": {
"type": "string",
"example": "WXC-25058",
"description": "User operation failure code."
}
}
},
"created": {
"type": "string",
"example": "2019-01-02T16:58:36.845Z",
"description": "The date and time the event took place."
},
"actorOrgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The `orgId` of the person who made the change."
},
"id": {
"type": "string",
"example": "MjQ0ODhiZTYtY2FiMS00ZGRkLTk0NWQtZDFlYjkzOGQ4NGUy",
"description": "A unique identifier for the event."
},
"actorId": {
"type": "string",
"example": "MjQ4Njg2OTYtYWMwZC00ODY4LWJkMjEtZGUxZDc4MzhjOTdm",
"description": "The `personId` of the person who made the change."
}
}
}