Skip to main content
📣 Try Nexigon today — sign up for a free account, no credit card required. 📣
Nexigon Docs
Documentation

Audit API

Actions in the audit namespace of the Nexigon Hub API.

audit_QueryAuditLogEvents

POST /api/v1/actions/invoke/audit_QueryAuditLogEvents

Query the events recorded in the audit log.

Requires administrator permissions.

Request QueryAuditLogEventsAction

No fields.

Response QueryAuditLogEventsOutput

Fields (JSON object)

  • events required

    List of audit events.

    array<AuditLogEvent>

    Items

    AuditLogEvent

    Fields (JSON object)

    • eventId (from event_id) required

      ID of the audit log event.

      AuditLogEventId string
    • actor required

      Actor causing the event.

      Actor

      Cases internally — tag field actor

      • Anonymous

        An anonymous, unauthenticated actor.

        { "actor": "Anonymous", ...<payload fields> } — or "content" for non-object payloads

        AnonymousActor

        No fields.

      • System

        The system itself, typically used for internal actions.

        { "actor": "System", ...<payload fields> } — or "content" for non-object payloads

        SystemActor

        No fields.

      • Device

        A device authenticated via a specific deployment token.

        { "actor": "Device", ...<payload fields> } — or "content" for non-object payloads

        DeviceActor

        Fields (JSON object)

        • deviceId (from device_id) required

          ID of the device.

          DeviceId string
        • tokenId (from token_id) required

          ID of the deployment token used for authentication.

          DeploymentTokenId string
      • User

        A user typically authenticated via a user session.

        { "actor": "User", ...<payload fields> } — or "content" for non-object payloads

        UserActor

        Fields (JSON object)

        • userId (from user_id) required

          ID of the user.

          UserId string
      • UserToken

        A user authenticated via a specific token.

        { "actor": "UserToken", ...<payload fields> } — or "content" for non-object payloads

        UserTokenActor

        Fields (JSON object)

        • userId (from user_id) required

          ID of the user.

          UserId string
        • tokenId (from token_id) required

          ID of the user token used for authentication.

          UserTokenId string
      • ClusterNode

        A cluster node.

        { "actor": "ClusterNode", ...<payload fields> } — or "content" for non-object payloads

        ClusterNodeActor

        Fields (JSON object)

        • nodeId (from node_id) required

          ID of the cluster node.

          ClusterNodeId string
      • OrganizationApiToken

        An organization API token.

        { "actor": "OrganizationApiToken", ...<payload fields> } — or "content" for non-object payloads

        OrganizationApiTokenActor

        Fields (JSON object)

        • organizationId (from organization_id) required

          ID of the organization.

          OrganizationId string
        • tokenId (from token_id) required

          ID of the API token.

          OrganizationApiTokenId string
    • event required

      Type of the event that was recorded.

      string
    • data required

      Additional audit data associated with the event.

      JsonValue any
    • createdAt (from created_at) required

      Timestamp indicating when the audit log event was recorded.

      Timestamp string
    • action optional

      Action the event has been caused by (if any).

      AuditLogEventAction

      Fields (JSON object)

      • actionId (from action_id) required

        ID of the action.

        AuditLogActionId string
    • job optional

      Job the event has been caused by (if any).

      AuditLogEventJob

      Fields (JSON object)

      • jobId (from job_id) required

        ID of the job.

        JobId string

audit_QueryAuditLogActions

POST /api/v1/actions/invoke/audit_QueryAuditLogActions

Query the actions recorded in the audit log.

Requires administrator permissions.

Request QueryAuditLogActionsAction

No fields.

Response QueryAuditLogActionsOutput

Fields (JSON object)

  • actions required

    List of actions.

    array<AuditLogAction>

    Items

    AuditLogAction

    Fields (JSON object)

    • actionId (from action_id) required

      ID of the audit log action.

      AuditLogActionId string
    • actor required

      Actor that performed the action.

      Actor

      Cases internally — tag field actor

      • Anonymous

        An anonymous, unauthenticated actor.

        { "actor": "Anonymous", ...<payload fields> } — or "content" for non-object payloads

        AnonymousActor

        No fields.

      • System

        The system itself, typically used for internal actions.

        { "actor": "System", ...<payload fields> } — or "content" for non-object payloads

        SystemActor

        No fields.

      • Device

        A device authenticated via a specific deployment token.

        { "actor": "Device", ...<payload fields> } — or "content" for non-object payloads

        DeviceActor

        Fields (JSON object)

        • deviceId (from device_id) required

          ID of the device.

          DeviceId string
        • tokenId (from token_id) required

          ID of the deployment token used for authentication.

          DeploymentTokenId string
      • User

        A user typically authenticated via a user session.

        { "actor": "User", ...<payload fields> } — or "content" for non-object payloads

        UserActor

        Fields (JSON object)

        • userId (from user_id) required

          ID of the user.

          UserId string
      • UserToken

        A user authenticated via a specific token.

        { "actor": "UserToken", ...<payload fields> } — or "content" for non-object payloads

        UserTokenActor

        Fields (JSON object)

        • userId (from user_id) required

          ID of the user.

          UserId string
        • tokenId (from token_id) required

          ID of the user token used for authentication.

          UserTokenId string
      • ClusterNode

        A cluster node.

        { "actor": "ClusterNode", ...<payload fields> } — or "content" for non-object payloads

        ClusterNodeActor

        Fields (JSON object)

        • nodeId (from node_id) required

          ID of the cluster node.

          ClusterNodeId string
      • OrganizationApiToken

        An organization API token.

        { "actor": "OrganizationApiToken", ...<payload fields> } — or "content" for non-object payloads

        OrganizationApiTokenActor

        Fields (JSON object)

        • organizationId (from organization_id) required

          ID of the organization.

          OrganizationId string
        • tokenId (from token_id) required

          ID of the API token.

          OrganizationApiTokenId string
    • action required

      Type of the action that was performed.

      string
    • data required

      Additional audit data associated with the action.

      object<string, JsonValue>

      Keys

      string

      Values

      JsonValue any
    • status required

      Status associated with the action

      AuditLogActionStatus

      Cases externally

      • Rejected

        Action got rejected (failed precondition check).

        Value: "Rejected"

      • Panicked

        Action or precondition check panicked (e.g., due to a bug).

        Value: "Panicked"

      • Succeeded

        Action was executed successfully.

        Value: "Succeeded"

      • Failed

        Action execution failed (e.g., due to missing permissions).

        Value: "Failed"

      • Pending

        Action is being executed.

        Value: "Pending"

    • createdAt (from created_at) required

      Timestamp indicating when the audit log action was recorded.

      Timestamp string