Eagle Eye Networks Auditlog API

openapi: 3.2.0
info:
  title: USER & ACCOUNTS Auditlog API
  version: 3.0.0
  description: Auditlog
servers:
- url: https://{BaseUrl}/api/v3.0
  description: Eagle Eye Networks API Server
  variables:
    BaseUrl:
      default: api.cxxx.eagleeyenetworks.com
      description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: Auditlog
  description: Auditlog
paths:
  /auditLogs:
    get:
      tags:
      - Auditlog
      operationId: listAuditlogs
      description: This endpoint filters audit events by userId, targetId, targetType, auditType
      parameters:
      - $ref: '#/components/parameters/include2'
      - $ref: '#/components/parameters/userId1'
      - $ref: '#/components/parameters/targetId'
      - $ref: '#/components/parameters/targetType'
      - $ref: '#/components/parameters/locationId'
      - $ref: '#/components/parameters/auditType'
      - $ref: '#/components/parameters/timestamp__gte'
      - $ref: '#/components/parameters/timestamp__lte'
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: List of audit events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEvents'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List auditlogs
      x-summary-source: derived
components:
  schemas:
    ErrorInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
        reason:
          description: 'The reason for the error. This is a constant value that identifies the proximate cause of the

            error. Error reasons are unique within a particular domain of errors.

            '
          type: string
          enum:
          - unauthenticated
          - unexpectedArgument
          - missingRequiredArgument
          - wrongArgumentValue
          - invalidPermission
          - wrongEdition
          - wrongAccountType
          - resourceNotFound
          - endpointNotFound
          - methodNotSupported
          - unexpectedError
          - acceptNotSupported
          - alreadyExists
          - foreignKeyConflict
          - childDevicesExist
          - contentNotSupported
          - deadlineExpired
          - tooManyRequests
          - deviceUnavailable
          - serviceUnavailable
          - invalidJSON
          - resourceLocked
          - notSupportedOnBridge
          - outOfRetention
          - deviceIdentificationFailed
          - credentialValidationFailed
          - credentialSetupFailed
          - localUrlValidationFailed
          - hwRegistrationFailed
          - failedAddingCameraAfterValidation
          - neverConnected
          - reconnectFailed
          - unsupportedModel
          - purged
          - userBlocked
          - userTemporarilyBlocked
          - quotaExceeded
          - alreadyValidated
          - reAuthenticationRequired
          - badGateway
        domain:
          description: 'Logical grouping to which the "reason" belongs

            '
          type: string
        metadata:
          $ref: '#/components/schemas/ExceptionMetadata'
    ExceptionDetail:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ErrorInfoExceptionDetail'
      - $ref: '#/components/schemas/BadRequestExceptionDetail'
      - $ref: '#/components/schemas/ResourceInfoExceptionDetail'
      discriminator:
        propertyName: type
        mapping:
          errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
          badRequest: '#/components/schemas/BadRequestExceptionDetail'
          resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
          - badRequest
          - resourceInfo
      required:
      - type
    GenericDetails:
      type: object
      required:
      - type
      - id
      - header
      - rows
      properties:
        type:
          type: string
          enum:
          - details
          description: 'Section type identifier. Currently only ''details'' is supported. Additional section types may be added in the future.

            '
          example: details
        id:
          type: string
          description: 'Machine-readable identifier for this section in camelCase. Should match the corresponding API v3 field name when applicable.

            '
          example: ioOutput1
        header:
          type: string
          description: 'Human-readable section label shown to users, representing a breadcrumb path to the corresponding screen in the web application. Use " - " as a separator for nested screens.

            '
          example: IO - Output 1
        rows:
          type: array
          description: 'List of setting changes or information displayed as rows in a table, each showing a label, current value, and optionally the previous value.

            '
          example:
          - id: turnOnOutput
            label: Turn on output
            value: relay_1
            oldValue: relay_old
          items:
            allOf:
            - $ref: '#/components/schemas/LabelValuePair'
            - type: object
              properties:
                format:
                  type: string
                  enum:
                  - date-time
                  - boolean
                  description: 'Optional format hint for the frontend to properly parse and display the value.


                    * `date-time`: Value is an ISO 8601 timestamp and should be rendered as a formatted date/time.

                    * `boolean`: Value is a boolean toggle (expects "Yes", "True", "No", or "False").

                    '
                  example: date-time
                oldValue:
                  type: string
                  description: 'Previous value of the setting before the change. Only include when there was a previous value (e.g., on updates). Omit for creates or when not applicable. Use empty string "" to represent "no value" rather than null.

                    '
                  example: relay_old
    AuditEvents:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponseNoTotalSize'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/AuditEvent'
    userId:
      type: string
      example: ca0de584
    AuditEvent:
      allOf:
      - $ref: '#/components/schemas/CreateAuditEvent'
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/id'
        ipAddressLocation:
          type: object
          properties:
            city:
              type: string
            region:
              type: string
            zipCode:
              type: string
            country:
              type: string
        description:
          type: string
        auditTypeName:
          type: string
    ApiV3Error:
      type: object
      properties:
        code:
          description: HTTP code defined in EEN Standard Code Values
          type: integer
        status:
          description: A string enum describing the code
          type: string
          enum:
          - cancelled
          - unknown
          - invalidArgument
          - deadlineExceeded
          - notFound
          - conflict
          - permissionDenied
          - resourceExhausted
          - failedPrecondition
          - aborted
          - outOfRange
          - unimplemented
          - internal
          - unavailable
          - dataLoss
          - unauthenticated
          - mediaTypeNotSupported
          - acceptNotSupported
          - methodNotSupported
          - tooManyRequests
          - badGateway
        message:
          description: Developer friendly human readable error message in English
          type: string
        details:
          description: An array of extensible objects that define error information
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
      required:
      - code
      - status
      - message
      - details
    id:
      type: string
      example: d290f1ee-6c54-4b01-90e6-d701748f0851
    BadRequestExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - badRequest
        argumentViolations:
          type: array
          items:
            $ref: '#/components/schemas/ArgumentViolation'
    CreateAuditEvent:
      type: object
      required:
      - userId
      - accountId
      - auditType
      - targetType
      - targetId
      - targetName
      properties:
        timestamp:
          $ref: '#/components/schemas/timestamp'
        userId:
          $ref: '#/components/schemas/userId'
        userName:
          type: string
        userEmail:
          type: string
        accountId:
          $ref: '#/components/schemas/accountId'
        auditType:
          type: string
        targetType:
          type: string
        targetId:
          type: string
        targetName:
          type: string
        ipAddress:
          type: string
        userAgent:
          type: object
          properties:
            browserFamily:
              type: string
            browserVersion:
              type: string
            osFamily:
              type: string
            osVersion:
              type: string
        locationId:
          $ref: '#/components/schemas/LocationId'
        locationName:
          type: string
        dataSchemas:
          type: array
          items:
            type: string
        data:
          type: array
          description: 'Structured audit details organized into sections for data-driven UI rendering. Each section represents a logical grouping of related settings or information, typically corresponding to a page or sub-section in the web application UI. The frontend can display new audit types and details without code changes by rendering these sections as labeled groups with rows of label-value pairs.

            '
          items:
            $ref: '#/components/schemas/GenericDetails'
    LabelValuePair:
      type: object
      description: 'Represents a setting or piece of information displayed in the audit log UI. Each pair contains a human-readable label matching the UI, a machine-readable identifier matching the API field name, and the current value.

        '
      required:
      - id
      - label
      - value
      properties:
        id:
          type: string
          description: 'Machine-readable identifier in camelCase. Should match the corresponding API v3 field name when applicable to make it easy to relate the API and audit log.

            '
          example: turnOnOutput
        label:
          type: string
          description: 'Human-readable label displayed to users in the frontend application UI, matching the label shown in the corresponding settings screen. Should be written in English.

            '
          example: Turn on output
        value:
          type: string
          description: 'Current value of the setting as a string. Use empty string "" to represent "no value" rather than null.

            '
          example: relay_1
    PaginatedResponseNoTotalSize:
      type: object
      description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages.

        '
      properties:
        nextPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

            '
        prevPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

            '
        results:
          type: array
          readOnly: true
          description: The result set from a collection API call.
          items:
            type: object
      required:
      - nextPageToken
      - prevPageToken
      - results
    targetType:
      type: string
      enum:
      - user
      - account
      - device
      - file
    ResourceInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - resourceInfo
        resource:
          description: Referenced resource type, eg "cameras", "bridges", or "locations".
          type: string
        ids:
          type: array
          description: Identities of resources
          items:
            type: string
    accountId:
      type: string
      example: '00011557'
    timestamp:
      type: string
      format: date-time
      example: '2021-04-22T00:00:00.000+00:00'
    ArgumentViolation:
      properties:
        argumentName:
          type: string
          description: Name of the argument
        description:
          type: string
          description: Description of the violation
    auditType:
      type: string
      description: Valid values given by /auditTypes endpoint.
      enum:
      - requestDownload
      - saveDownload
      - createDevice
      - deleteDevice
      - updateDevice
      - createAccount
      - updateAccount
      - createUser
      - createUserSso
      - deleteUser
      - updateUser
      - switchAccount
      - devicesOn
      - devicesOff
      - deviceRestart
      - userLogin
      - userLogout
      - getLayout
      - createLayout
      - deleteLayout
      - updateLayout
      - managedSwitchControl
      - managedSwitchUpdate
      - forgotPassword
      - resetPassword
      - videoRecordStart
      - videoRecordEnd
      - viewVideoEnd
      - viewVideoStart
      - createFile
      - deleteFile
      - updateFile
      - activateFirstResponders
      - deactivateFirstResponders
      - openTunnel
      - closeTunnel
      - activeOutput0
      - activeOutput1
      - activeOutput2
      - activeOutput3
      - lprSearch
      - videoSearch
      - cameraSnapshot
      - talkdownSessionStarted
      - talkdownSessionFinished
      - createLocation
      - updateLocation
      - deleteLocation
    ExceptionMetadata:
      properties:
        path:
          description: Path of the request
          type: string
        method:
          description: Method of the request
          type: string
    LocationId:
      description: ID Of the location.
      minLength: 1
      type:
      - string
      - 'null'
      example: 2428fda3-389f-48ce-b062-85875dd6b2e2
  responses:
    forbidden:
      description: You have no permission to access the specified resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            invalidPermission:
              value:
                code: 403
                status: permissionDenied
                message: The client caller does not have permission for the specified operation
                details:
                - type: errorInfo
                  reason: invalidPermission
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            wrongEdition:
              value:
                code: 403
                status: permissionDenied
                message: This feature is not enabled for the account
                details:
                - type: errorInfo
                  reason: wrongEdition
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
            wrongAccountType:
              value:
                code: 403
                status: permissionDenied
                message: This feature is only available for end users
                details:
                - type: errorInfo
                  reason: wrongAccountType
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
    internalServerError:
      description: Something went wrong in the server. Please try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 500
            status: internal
            message: An internal error has occurred. Please try again later.
            details:
            - type: errorInfo
              reason: unexpectedError
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    unauthorized:
      description: You are not authenticated. Please authenticate and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 401
            status: unauthenticated
            message: The client caller does not have a valid authentication credential
            details:
            - type: errorInfo
              reason: unauthenticated
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    validationError:
      description: The supplied object is invalid. Error detail will contain the validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            unexpectedArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Unexpected argument: name'
                details:
                - type: errorInfo
                  reason: unexpectedArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            missingRequiredArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Missing required arguments: name, id'
                details:
                - type: errorInfo
                  reason: missingRequiredArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidJSON:
              value:
                code: 400
                status: invalidArgument
                message: Invalid JSON
                details:
                - type: errorInfo
                  reason: invalidJSON
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Invalid Argument: Argument name is too long'
                details:
                - type: errorInfo
                  reason: wrongArgumentValue
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: badRequest
                  argumentViolations:
                  - argumentName: name
                    description: Name is too long
  parameters:
    userId1:
      in: query
      name: userId
      description: Filter by userId
      required: false
      schema:
        $ref: '#/components/schemas/userId'
    targetType:
      in: query
      name: targetType
      description: Filter by targetType
      required: false
      schema:
        $ref: '#/components/schemas/targetType'
    timestamp__lte:
      in: query
      name: timestamp__lte
      description: Maximum timestamp to list auditlogs.
      schema:
        $ref: '#/components/schemas/timestamp'
    locationId:
      in: query
      name: locationId
      description: Filter by locationId
      required: false
      schema:
        type: string
    include2:
      in: query
      name: include
      schema:
        type: string
        enum:
        - description
        - userAgent
        - data
        - ipAddressLocation
    auditType:
      in: query
      name: auditType
      description: Filter by auditType
      required: false
      schema:
        $ref: '#/components/schemas/auditType'
    targetId:
      in: query
      name: targetId
      description: Filter by targetId
      required: false
      schema:
        type: string
    pageSize:
      in: query
      name: pageSize
      description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and  maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.

        '
      example: 100
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    timestamp__gte:
      in: query
      name: timestamp__gte
      description: Minimum timestamp to list auditlogs.
      schema:
        $ref: '#/components/schemas/timestamp'
    pageToken:
      in: query
      name: pageToken
      description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.

        When a pageToken is provided, the backend remembers search parameters from the original request, so search  parameters that affect the result set or order are optional and will be ignored if provided. Representation  parameters like `include` should still be applied.

        '
      example: b2Zmc2V0PTEwJmxpbWl0PTEw
      required: false
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://developer.eagleeyenetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.eagleeyenetworks.com/reference/createresourcegrants.md
  - https://developer.eagleeyenetworks.com/reference/createrole.md
  - https://developer.eagleeyenetworks.com/reference/createroleassignments.md
  - https://developer.eagleeyenetworks.com/reference/createuser.md
  - https://developer.eagleeyenetworks.com/reference/deletecredential.md
  - https://developer.eagleeyenetworks.com/reference/deleteresourcegrants.md
  - https://developer.eagleeyenetworks.com/reference/deleterole.md
  - https://developer.eagleeyenetworks.com/reference/deleteroleassignments.md
  - https://developer.eagleeyenetworks.com/reference/deletetrustedclient.md
  - https://developer.eagleeyenetworks.com/reference/deleteuser.md
  - https://developer.eagleeyenetworks.com/reference/getcurrentuser.md
  - https://developer.eagleeyenetworks.com/reference/getedition.md
  - https://developer.eagleeyenetworks.com/reference/geteditions.md
  - https://developer.eagleeyenetworks.com/reference/getresourcegrants.md
  - https://developer.eagleeyenetworks.com/reference/getrole.md
  - https://developer.eagleeyenetworks.com/reference/getroleassignments.md
  - https://developer.eagleeyenetworks.com/reference/getroles.md
  - https://developer.eagleeyenetworks.com/reference/gettrustedclients.md
  - https://developer.eagleeyenetworks.com/reference/getuser.md
  - https://developer.eagleeyenetworks.com/reference/getusers.md
  - https://developer.eagleeyenetworks.com/reference/listaccounts.md
  - https://developer.eagleeyenetworks.com/reference/listauditlogs.md
  - https://developer.eagleeyenetworks.com/reference/updatecurrentuser.md
  - https://developer.eagleeyenetworks.com/reference/updaterole.md
  - https://developer.eagleeyenetworks.com/reference/updateuser.md
  merge:
    pages: 25
    deduped: 428
    conflicts_kept_first: 0