UserSession

UserSession
UserSession

Information about a current user session.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "userName": "string",
    "fullName": "string",
    "loginTime": "string",
    "lastActiveTime": "string",
    "locale": "string",
    "messageLocale": "string",
    "extensionSession": false,
    "ipAddress": "string",
    "userAgent": "string",
    "callCount": 0
}
string
key
Required

A unique identifier for this session, also known as the session ID.

string
userName
Required

The user name represented by this session.

string
fullName
Required

The full name of the user, if available.

string As date-time As date-time
loginTime
Required

Timestamp when the user last logged on to the server.

string As date-time As date-time
lastActiveTime
Required

Timestamp when the user last executed a command.

string
locale
Required

The locale for the session used for data formatting and preferred for messages.

string
messageLocale
Required

The locale used for messages for the session.

If there are no localized messages for the user-specified locale, then the server determines this locale.

boolean
extensionSession
Required

Whether or not this session belongs to a VC Extension.

string
ipAddress
Required

The client identity.

It could be IP address, or pipe name depended on client binding

string
userAgent
Required

The name of user agent or application

integer As int64 As int64
callCount
Required

Number of API invocations since the session started