compliance

Log security event

Log a security event for compliance and audit (e.g. SOC 2, GDPR). Event type and severity are required; optional details (userId, resource, ipAddress, etc.) for forensics.

POST/api/compliance/security-event

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Request Body

Event type (e.g. unauthorized_access_attempt, brute_force_attempt), severity (low–critical), and optional details object for context.

json
{
  "eventType": "unauthorized_access_attempt",
  "severity": "high",
  "details": {
    "userId": "usr_3HjF6SCqdOmxz6",
    "resource": "alarm program",
    "ipAddress": "2667 Beryl Passage",
    "userAgent": "monitor compress",
    "action": "feed index",
    "reason": "driver navigate"
  }
}
{
  "eventType": "unauthorized_access_attempt",
  "severity": "high",
  "details": {
    "userId": "usr_3HjF6SCqdOmxz6",
    "resource": "alarm program",
    "ipAddress": "2667 Beryl Passage",
    "userAgent": "monitor compress",
    "action": "feed index",
    "reason": "driver navigate"
  }
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.compliance.logSecurityEvent({
  eventType: "port index",
  severity: "monitor generate",
  details: "port override"
});
const result = await client.compliance.logSecurityEvent({
  eventType: "port index",
  severity: "monitor generate",
  details: "port override"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Security event logged
json
{
  "success": true,
  "message": "Security event recorded",
  "eventId": "evt_abc123"
}
{
  "success": true,
  "message": "Security event recorded",
  "eventId": "evt_abc123"
}
400Bad request or validation error.
401Authentication required or invalid token.

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.

Next steps

Edit this page on GitHub