Server Administration

This module adds capabilities for server administrators to inspect server state and data.

Client Behaviour

GET /_matrix/client/v3/admin/whois/{userId}

Gets information about a particular user.

This API may be restricted to only be called by the user being looked up, or by a server admin. Server-local administrator privileges are not specified in this document.

Rate-limited:	No
Requires authentication:	Yes

Request

Request parameters

path parameters
Name	Type	Description
`userId`	`string`	Required: The user to look up.

Responses

Status	Description
`200`	The lookup was successful.

200 response

Name	Type	Description
`devices`	`{string: DeviceInfo}`	Each key is an identifier for one of the user’s devices.
`user_id`	`string`	The Matrix user ID of the user.

DeviceInfo
Name	Type	Description
`sessions`	`[SessionInfo]`	A user’s sessions (i.e. what they did with an access token from one login).

SessionInfo
Name	Type	Description
`connections`	`[ConnectionInfo]`	Information particular connections in the session.

ConnectionInfo
Name	Type	Description
`ip`	`string`	Most recently seen IP address of the session.
`last_seen`	`integer`	Unix timestamp that the session was last active.
`user_agent`	`string`	User agent string last seen in the session.

{
  "devices": {
    "teapot": {
      "sessions": [
        {
          "connections": [
            {
              "ip": "127.0.0.1",
              "last_seen": 1411996332123,
              "user_agent": "curl/7.31.0-DEV"
            },
            {
              "ip": "10.0.0.2",
              "last_seen": 1411996332123,
              "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.120 Safari/537.36"
            }
          ]
        }
      ]
    }
  },
  "user_id": "@peter:rabbit.rocks"
}