Resource URL: /platform/<<version=1>>/protocols/smb/sessions

    Overview: This resource allows listing all SMB sessions currently open on
              the queried node.

     Methods: GET

********************************************************************************

Method GET: List open sessions.

       URL: GET /platform/<<version=1>>/protocols/smb/sessions

Query arguments:
    sort=<enum> Where <enum> is one of computer, user, client_type, openfiles,
                active_time, idle_time, guest_login, encryption.  Order results
                by this field.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "sessions": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "active_time": {
                "required": true, 
                "type": "integer", 
                "description": "Number of seconds since session start."
              }, 
              "computer": {
                "required": true, 
                "type": "string", 
                "description": "Client internet address."
              }, 
              "encryption": {
                "required": true, 
                "type": "boolean", 
                "description": "True if session is encrypted."
              }, 
              "idle_time": {
                "required": true, 
                "type": "integer", 
                "description": "Number of seconds since last client operation."
              }, 
              "client_type": {
                "required": true, 
                "type": "string", 
                "description": "Client type."
              }, 
              "guest_login": {
                "required": true, 
                "type": "boolean", 
                "description": "True for guest logins."
              }, 
              "openfiles": {
                "required": true, 
                "type": "integer", 
                "description": "Number of files open by client."
              }, 
              "id": {
                "required": true, 
                "type": "integer", 
                "description": "The session ID."
              }, 
              "user": {
                "required": true, 
                "type": "string", 
                "description": "Local user name."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}
