session.info

The session.info command is used to obtain information about the current session.

TR50 Request

{
  "cmd": {
    "command": "session.info"
  }
}

Request Parameters

The command takes no parameters. It only returns for the current session.

TR50 Response

If the command is sent successfully a success message and params list is returned. Otherwise, an error and error message will be returned.

{
    "1": {
        "success": true,
        "params": {
            "id": "590f67bdd733180364e973f2c63a8cc2",
            "ref": "d6c8e12879cc25a011fbb8aab7168b3b91f24a43c72a2c74486f4b5b04fa4b1f",
            "serverId": "engr-us-open-ash",
            "orgId": "5c99185cfe2a13368ec52c82",
            "orgKey": "MARCUS",
            "userId": "57582581681fdc4823d3e32c",
            "userName": "marcus.guerrier@telit.com",
            "whoAmI": "marcus.guerrier@telit.com",
            "ipAddress": "64.187.134.87",
            "hasSuperAdmin": true,
            "hasSuperOps": false,
            "hasOrgAdmin": true,
            "connInfo": {
                "protocol": "HTTP",
                "remoteAddr": "64.187.134.87"
            },
            "ttl": 86400,
            "locale": "en_US",
            "allowSubOrgAccess": null,
            "startTime": "2024-02-29T16:56:05.465Z",
            "lastAccessed": "2024-02-29T18:44:44.036Z",
            "allAgreementsSigned": true,
            "initial": false,
            "orgProfileSettings": {
                "maxRetention": -1,
                "enCloudTriggers": true,
                "enCampaigns": true,
                "enCdpAccess": true,
                "enEuicc": false,
                "disableMgmtPortal": false,
                "disableCustObjDefs": false
            }
        }
    }
}

The returned session information for a user with Admin privileges will not include the 'perms' or the 'roleKeys' parameters.

Response Parameters

Response results will differ between a user-based session and an application-based session.

Name	Type	Description
ref	String	Ref is an identifier of session.
serverId	String	The unique identifier of the current server.
orgId	String	A unique identifier for the sessions current organization.
orgKey	String	The key of the current session organization.
appName	String	In an application session this is the name of the current application.
tokenId	String	In an application session this is the current applicationToken.
tokenName	String	In an application session this is the name of the current applicationToken.
thingKey	String	In an application session this is the thingKey of the current Thing.
userId	String	In a user session this is a unique identifier for the current user.
userName	String	In a user session this is the user name for the current user.
whoAmI	String	A string identifying the current application or user.
hasSuperAdmin	Boolean	True if the current session has Super Administration access.
hasSuperOps	Boolean	True if the current session has Super Ops access.
hasOrgAdmin	Boolean	True if the current session has Organization Administration access.
connInfo	Object	Connection details for the current session.
connInfo.protocol	String	The connection protocol being used.
connInfo.remoteAddr	String	The remote address of the connection.
ttl	Integer	TTL (time to live) value for the current session.
locale	String	The localization and language setting for the current session.
perms	Object	Identifies the list of permissions available to the session and the boolean setting.
roleKeys	String	Identifies the list of Roles assigned to the User that owns this session.
support	Boolean	Whether the user has access to the support system.
maxThings	Integer	The maximum number of Things allowed in the profile.
maxCampaignSize	Integer	The maximum campaign size allowed in the profile.
maxRetention	Integer	The maximum retention, in days.
enCloudTriggers	Boolean	If true, then the cloud triggers are enabled.
enCampaigns	Boolean	If true, then the campaigns are enabled.
enCdpAccess	Boolean	If true, then the CDP access is enabled.
enEuicc	Boolean	Whether eUICC is enabled.
disableMgmtPortal	Boolean	If true, then users won't be able to log into the management portal. The disableMgmtPortal prevents access to the features of Management Portal. It doesn't prevent API access.
disableCustObjDefs	Boolean	If true, the lwm2m.metadata.register/deregister will not be executed and an error will be returned.
passwordExpiry	Timestamp	The date when the user's password expires and must be changed.

PHP API

mixed TR50httpWorker::sessionInfo();