/mgmt/status/default/ActiveUsers GET

Use the HTTP GET method with the /mgmt/status/default/ActiveUsers resource to request a list of current appliance users.

Resource URL

https://host:port/mgmt/status/default/ActiveUsers
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes all current users of the appliance within an "ActiveUsers" section. Each object contains the following fields:
session
Integer.
A system-assigned session identifier.
name
String.
The user name presented during login.
connection
String.
The method used to connect to the device, such as web-gui (using a browser), cli (through telnet or ssh), or serial (via a serial cable). The possible values are:
  • serial
  • ssh
  • web-mgmt
  • xml-mgmt
  • system
address
String.
The IP address of the user's client machine. Not valid for serial connections.
login
String.
Time of login.
domain
String.
Always set to "default".

Examples

The following example requests a list of the current users on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/ActiveUsers
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/ActiveUsers"
    },
    "doc": {
      "href": "/mgmt/docs/status/ActiveUsers"
    }
  },
  "ActiveUsers": [
    {
      "session": 55168,
      "name": "admin",
      "connection": "web-gui",
      "address": "198.51.100.40",
      "login": "Mon Dec 24 10:21:02 2018",
      "domain": "default"
    },
    {
      "session": 55169,
      "name": "admin2",
      "connection": "saml-artifact",
      "address": "198.51.100.20",
      "login": "Mon Dec 24 10:23:09 2018",
      "domain": "default"
    }
  ]
}