session.info

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.


                        {
  "cmd": {
    "success": true,
    "params": {
      "id": "5342ba92d15a70272c000003",
      "serverId": "ip-10-200-40-12",
      "orgId": "52fbe4028a3a515d4aded7f1",
      "orgKey": "SYSTEM",
      "userId": "52fbe4028a3a515d4aded7f6",
      "userName": "admin@example.com",
      "whoAmI": "admin@example.com",
      "hasSuperAdmin": false,
      "hasSuperOps": false,
      "hasOrgAdmin": false,
      "connInfo": {
        "protocol": "http",
        "remoteAddr": "127.0.0.1:50061"
      },
      "ttl": 86400,
      "locale": "",
      "perms": {
        "alarm.history": true,
        "alarm.history.multi": true,
        "alarm.summary":true,
        "user.org.tag.cloud": true
      },
      "roleKeys": [           
        "role-acmeissuecommands",       
        "role-acmeviewonly"
      ]
    }
  }
}

Note: The returned session information for a user with Admin privileges will not include in the response 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
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.
appId	String	In an application session this is a unique identifier for the current application.
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.