JSON - Users.adoc

JSON - Users

This returns periodic messages containing the users logged into the EdgeOS device (including via SSH, Web and VPN).

Table of Contents

• Response
  • Root
  • users Object
  • UserConnection Object
  • ConnectionType Types
• Examples
  • 2 Connected Users

Response

Root

Name	Type	Values	Description
local	Array (Object)	Array of users	The users currently connected.

users Object

Name	Type	Values	Description
Key	String	Username (e.g. admin)	The username currently connected.
Value	Array (Object)	Array of UserConnection	The connection details of the username currently connected.

UserConnection Object

Name	Type	Values	Description
tty	String	ConnectionType (e.g. Web)	The method the user is currently connected.
idle	Number	Number (0+)	How long the user has been idle for.
host	String	String (Laptop) or empty string	The hostname the user has been resolved to (if known).
uptime	String	Time in days, hours, minutes and seconds (e.g. 1d2h3m4s)	How long the user has been connected for.

ConnectionType Types

These are the currently known connection types:

• Web

• pts/n

Examples

2 Connected Users

Users Example

502
{
    "users": {
        "local": [
            {
                "admin": {
                    "tty": "Web",
                    "idle": "0",
                    "host": "",
                    "uptime": "01h55m03s"
                }
            },
            {
                "admin": {
                    "tty": "pts\/0",
                    "idle": "4901",
                    "host": "192.168.0.100",
                    "uptime": "01h33m44s"
                }
            }
        ]
    }
}