aaa_audit-logs

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
action	object
actor	object
id	string	A string that uniquely identifies the audit log.
interface	string	The source of the event.
metadata	object	An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.
newValue	string	The new value of the resource that was modified.
oldValue	string	The value of the resource before it was modified.
owner	object
resource	object
when	string	A UTC RFC3339 timestamp that specifies when the action being logged occured.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/aaa_audit-logs",
  "title": "aaa_audit-logs",
  "properties": {
    "action": {
      "properties": {
        "result": {
          "description": "A boolean that indicates if the action attempted was successful.",
          "example": true,
          "type": "boolean"
        },
        "type": {
          "description": "A short string that describes the action that was performed.",
          "example": "change_setting",
          "type": "string"
        }
      },
      "type": "object"
    },
    "actor": {
      "properties": {
        "email": {
          "description": "The email of the user that performed the action.",
          "example": "[email protected]",
          "format": "email",
          "type": "string"
        },
        "id": {
          "description": "The ID of the actor that performed the action. If a user performed the action, this will be their User ID.",
          "example": "f6b5de0326bb5182b8a4840ee01ec774",
          "type": "string"
        },
        "ip": {
          "description": "The IP address of the request that performed the action.",
          "example": "198.41.129.166",
          "type": "string"
        },
        "type": {
          "description": "The type of actor, whether a User, Cloudflare Admin, or an Automated System.",
          "enum": [
            "user",
            "admin",
            "Cloudflare"
          ],
          "example": "user",
          "type": "string"
        }
      },
      "type": "object"
    },
    "id": {
      "description": "A string that uniquely identifies the audit log.",
      "example": "d5b0f326-1232-4452-8858-1089bd7168ef",
      "type": "string"
    },
    "interface": {
      "description": "The source of the event.",
      "example": "API",
      "type": "string"
    },
    "metadata": {
      "description": "An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.",
      "example": {
        "name": "security_level",
        "type": "firewall",
        "value": "high",
        "zone_name": "example.com"
      },
      "type": "object"
    },
    "newValue": {
      "description": "The new value of the resource that was modified.",
      "example": "low",
      "type": "string"
    },
    "oldValue": {
      "description": "The value of the resource before it was modified.",
      "example": "high",
      "type": "string"
    },
    "owner": {
      "properties": {
        "id": {
          "$ref": "#/components/schemas/aaa_identifier"
        }
      },
      "type": "object"
    },
    "resource": {
      "properties": {
        "id": {
          "description": "An identifier for the resource that was affected by the action.",
          "example": "023e105f4ecef8ad9ca31a8372d0c353",
          "type": "string"
        },
        "type": {
          "description": "A short string that describes the resource that was affected by the action.",
          "example": "zone",
          "type": "string"
        }
      },
      "type": "object"
    },
    "when": {
      "description": "A UTC RFC3339 timestamp that specifies when the action being logged occured.",
      "example": "2017-04-26T17:31:07Z",
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}