ListEventsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cloudera/main/json-schema/cloudera-list-events-request-schema.json",
  "title": "ListEventsRequest",
  "description": "Request object for the ListEvents method.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudera-audit-api-openapi.yml#/components/schemas/ListEventsRequest",
  "type": "object",
  "required": [
    "fromTimestamp",
    "toTimestamp"
  ],
  "properties": {
    "fromTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The beginning timestamp for the search range (inclusive)."
    },
    "toTimestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The ending timestamp for the search range (exclusive)."
    },
    "pageSize": {
      "type": "integer",
      "format": "int32",
      "minimum": 20,
      "maximum": 50,
      "x-paging-page-size": true,
      "description": "The page size."
    },
    "pageToken": {
      "type": "string",
      "x-paging-input-token": true,
      "description": "The page token."
    },
    "requestId": {
      "type": "string",
      "description": "The optional request ID. If specified, only events associated with this request ID are returned."
    },
    "eventSource": {
      "type": "string",
      "description": "The optional source service. If specified, only events associated with this event source are returned. The source must be the name of a service as enumerated in the CRN definition."
    },
    "eventName": {
      "type": "string",
      "description": "The optional event name. If specified, only events with this name are returned."
    },
    "actorCrn": {
      "type": "string",
      "description": "The optional actor CRN. If specified, only events with this CRN recorded for the actor identity are returned."
    },
    "resultCode": {
      "type": "string",
      "description": "The optional result code. If specified, only events with this result code are returned. Events without a result code are not returned."
    },
    "resultMessage": {
      "type": "string",
      "description": "The optional result message. If specified, only events with this result message are returned. Events without a result message are not returned."
    },
    "apiRequestEventCriteria": {
      "description": "Optional additional filtering criteria for listing API request audit events.",
      "$ref": "#/$defs/ApiRequestEventCriteria"
    },
    "cdpServiceEventCriteria": {
      "description": "Optional additional filtering criteria for listing CDP service audit events.",
      "$ref": "#/$defs/CdpServiceEventCriteria"
    },
    "interactiveLoginEventCriteria": {
      "description": "Optional additional filtering criteria for listing interactive login audit events.",
      "$ref": "#/$defs/InteractiveLoginEventCriteria"
    }
  },
  "$defs": {
    "ApiRequestEventCriteria": {
      "type": "object",
      "description": "Filter criteria for listing API request audit events.",
      "properties": {
        "sourceIPAddress": {
          "type": "string",
          "description": "The source IP address of the requester."
        },
        "userAgent": {
          "type": "string",
          "description": "The user agent that made the API request."
        }
      }
    },
    "CdpServiceEventCriteria": {
      "type": "object",
      "description": "Filter criteria for listing CDP service audit events.",
      "properties": {
        "resourceCrn": {
          "type": "string",
          "description": "The CRN of the resource operated on."
        }
      }
    },
    "InteractiveLoginEventCriteria": {
      "type": "object",
      "description": "Filter criteria for listing interactive login audit events.",
      "properties": {
        "identityProviderUserId": {
          "type": "string",
          "description": "The user ID as indicated by the identity provider. The specific format and type of this identifier is determined by the IdP. For Cloudera SSO this is the email used to login."
        },
        "email": {
          "type": "string",
          "description": "The email of the user as provided to CDP."
        },
        "sourceIPAddress": {
          "type": "string",
          "description": "The source IP address from which the login request came."
        },
        "firstName": {
          "type": "string",
          "description": "The first name of the user."
        },
        "lastName": {
          "type": "string",
          "description": "The last name of the user."
        }
      }
    }
  }
}