{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/getAuditLogs",
"title": "Successful Response",
"type": "object",
"properties": {
"trails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The audit event's ID.",
"example": 12345678
},
"ip": {
"type": "string",
"description": "The IP address of the user that performed the action.",
"example": "192.0.2.0"
},
"userAgent": {
"type": "string",
"description": "The user agent information.",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
},
"action": {
"type": "string",
"description": "The action performed by the user.",
"example": "user.login_google_success"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the event occurred.",
"example": "2022-08-31T15:19:32.000Z"
},
"message": {
"type": "string",
"description": "The audit event's description.",
"example": "Taylor Lee successfully logged in using the Google OAuth."
},
"data": {
"type": "object",
"properties": {
"actor": {
"type": "object",
"description": "Information about the user who preformed the audit event.",
"properties": {
"name": {
"type": "string",
"description": "The user's name.",
"example": "Taylor Lee"
},
"username": {
"type": "string",
"description": "The user's username.",
"example": "taylor-lee"
},
"email": {
"type": "string",
"format": "email",
"description": "The user's email address.",
"example": "[email protected]"
},
"id": {
"type": "number",
"example": 12345678
},
"active": {
"type": "boolean",
"description": "If true, the user is active. If false, the user is deactivated.",
"example": true
}
}
},
"user": {
"type": "object",
"description": "Information about the user.",
"properties": {
"name": {
"type": "string",
"description": "The user's name.",
"example": "Taylor Lee"
},
"username": {
"type": "string",
"description": "The user's username.",
"example": "taylor-lee"
},
"email": {
"type": "string",
"format": "email",
"description": "The user's email address.",
"example": "[email protected]"
},
"id": {
"type": "number",
"description": "The user's ID.",
"example": 12345678
}
}
},
"team": {
"type": "object",
"description": "The user's team information.",
"properties": {
"name": {
"type": "string",
"description": "The team's name.",
"example": "Test-Team"
},
"id": {
"type": "number",
"description": "The team's ID.",
"example": 1234
}
}
},
"variables": {
"type": "object",
"description": "Additional information about the performed action.",
"additionalProperties": true
}
}
}
}
}
}
}
}