session.find
The session.find command is used to obtain information about a session.
TR50 Request
{
"cmd": {
"command": "session.find",
"params": {
"id": "53398c17d15a702a78000003"
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
id | String | The Id of the session. | |
ref | String | Ref is another session identifier. |
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":{
"ref":"93d2a2a53a1bf15cbed459c1e3681404a1e700c74063fab4458d0a4f126813d1",
"orgId":"52fbe4028a3a515d4aded7f1",
"orgKey":"SYSTEM",
"userId":"52fbe4028a3a515d4aded7f6",
"userName":"admin@devicewise.com",
"whoAmI":"admin@devicewise.com",
"hasSuperAdmin":true,
"hasSuperOps":false,
"hasOrgAdmin":false,
"connInfo":{
"protocol":"http",
"remoteAddr":"127.0.0.1:50061"
},
"ttl":86400,
"locale":"",
"allowSubOrgAccess":null,
"startTime":"2021-08-10T12:55:19.568Z",
"lastAccessed":"2021-08-10T22:28:50.564Z",
"allAgreementsSigned":false
}
}
}
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. |
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 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. |