Get Active Users

GET 
/settings/users/active-users

Returns a list of users currently active in the system, including their browser, OS, and session duration.

Request

Responses

200

A list of active user sessions retrieved successfully.

application/json

Schema

Schema

status string
response-code integer
result object[]
Array [
browser string
version string
majorVersion integer
userAgent string
os string
user.id int64
last.active.timestamp int64
Unix timestamp of the last activity.
duration integer
Session duration in seconds or milliseconds.
user.name string
user.type string
remote.address ipv4
]

Example (from schema)

{
  "status": "succeed",
  "response-code": 200,
  "result": [
    {
      "browser": "Chrome",
      "version": "134.0.0.0",
      "majorVersion": 134,
      "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/134.0.0.0 Safari/537.36",
      "os": "Linux",
      "user.id": 10000000000001,
      "last.active.timestamp": 1772099443,
      "duration": 268163,
      "user.name": "admin",
      "user.type": "System",
      "remote.address": "10.20.41.105"
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

The server understood the request but refuses to authorize it. This can happen if the client does not have the necessary permissions to access this resource.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

The server encountered an unexpected error that prevented it from fulfilling the request.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...