Endpoint

/v1/smb/sessions/

GET

Enumerate open sessions

Parameters

Name Description Required
identity List only sessions matching a user identity in the form of: [1] A name or a SID optionally qualified with a domain prefix (e.g local:name, S-1-1-0, name, world:Everyone, ldap_user:name, or ad:name), or [2] An ID type (e.g. uid:1001, auth_id:513, SID:S-1-1-0).) No
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_smb_sessions_get_response",
  "type": "object",
  "properties": {
    "session_infos": {
      "type": "array",
      "items": {
        "description": "session_infos",
        "type": "object",
        "properties": {
          "location": {
            "description": "location",
            "type": "string"
          },
          "tenant_id": {
            "description": "tenant_id",
            "type": "number"
          },
          "originator": {
            "description": "originator",
            "type": "string"
          },
          "server_address": {
            "description": "server_address",
            "type": "string"
          },
          "user": {
            "description": "user",
            "type": "object",
            "properties": {
              "domain": {
                "type": "string",
                "enum": [
                  "LOCAL",
                  "API_NULL_DOMAIN",
                  "WORLD",
                  "POSIX_USER",
                  "POSIX_GROUP",
                  "ACTIVE_DIRECTORY",
                  "API_INVALID_DOMAIN",
                  "API_RESERVED_DOMAIN",
                  "API_INTERNAL_DOMAIN",
                  "API_OPERATOR_DOMAIN",
                  "API_CREATOR_DOMAIN"
                ],
                "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
              },
              "auth_id": {
                "description": "auth_id",
                "type": "string"
              },
              "uid": {
                "description": "uid",
                "type": "number"
              },
              "gid": {
                "description": "gid",
                "type": "number"
              },
              "sid": {
                "description": "sid",
                "type": "string"
              },
              "name": {
                "description": "name",
                "type": "string"
              }
            }
          },
          "num_opens": {
            "description": "num_opens",
            "type": "number"
          },
          "time_open": {
            "description": "time_open",
            "type": "object",
            "properties": {
              "nanoseconds": {
                "description": "nanoseconds",
                "type": "string"
              }
            }
          },
          "time_idle": {
            "description": "time_idle",
            "type": "object",
            "properties": {
              "nanoseconds": {
                "description": "nanoseconds",
                "type": "string"
              }
            }
          },
          "is_guest": {
            "description": "is_guest",
            "type": "boolean"
          },
          "is_encrypted": {
            "description": "is_encrypted",
            "type": "boolean"
          },
          "share_names": {
            "type": "array",
            "items": {
              "description": "share_names",
              "type": "string"
            }
          }
        }
      }
    }
  }
}