跳到主要内容

ActiveConnectionsItemDto

One open connection of a user: where the sign-in behind it came from, and the ID it can be closed by.

NameTypeDescriptionNotes
idInteger (int32)The ID of the sign-in this connection was opened by. Pass it as loginEventId to PUT api/2.0/security/activeconnections/logout/{loginEventId} to end this one connection; the item whose value equals loginEvent is the connection the current request uses.[required] [example: 1]
tenantIdInteger (int32)The portal the sign-in was made on. The operation never crosses portals, so it is the current one on every item.[required] [example: 1]
userIdUUID (uuid)The user the connection belongs to, which is the calling user on every item - the operation cannot report anyone else's connections.[required] [example: 00000000-0000-0000-0000-000000000000]
mobileBooleanWhether the sign-in came from a mobile client. No mobile marker is stored with a connection, so the value is false on every item and tells a caller nothing about the device.[optional] [example: true]
ipStringThe IP address the sign-in came from, with the port stripped off. On the item that matches loginEvent it is taken from the address the current request arrives from instead of the one stored at sign-in.[optional] [example: 192.0.2.1] [nullable]
countryStringThe English name of the country the IP address is located in. It is empty when the address cannot be located, which is the normal outcome for private and loopback addresses.[optional] [example: United States] [nullable]
cityStringThe city the IP address is located in, empty under the same conditions as country.[optional] [example: New York] [nullable]
browserStringThe browser and its version as parsed from the user agent of the sign-in, empty when the client sent no recognisable one. It is refreshed from the current request on the item that matches loginEvent.[optional] [example: Chrome 120.0] [nullable]
platformStringThe operating system as parsed from the user agent of the sign-in, refreshed and left empty under the same conditions as browser.[optional] [example: Windows] [nullable]
dateApiDateTimeWhen the sign-in happened, in the portal time zone rather than in UTC.[optional]
pageStringWhere in the portal the sign-in was made from: the referrer of the request that created it, or that request's own path when it carried no referrer. Long values are cut off at 512 characters.[optional] [example: /rooms/shared] [nullable]