Retrieves logged-on users for the given computers for selective logoff operations

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the list of currently logged-on users for each of the specified computers. Used to allow technicians to select specific users when executing a logoff-targeted shutdown operation.

Request URL

https://{server-hostname}:8383/dcapi/tools/shutdown/getLoggedOnUsers

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/loggedOnUsersList.v1+jsonapplication/loggedOnUsersList.v1+jsonCopied!
Content-TypestringMandatory
application/getLoggedOnUsersParams.v1+jsonapplication/getLoggedOnUsersParams.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
computersJSON ArrayOptional
Show Sub-Attributes
string

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/dcapi/tools/shutdown/getLoggedOnUsers \
  --header 'Accept: application/loggedOnUsersList.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/getLoggedOnUsersParams.v1+json' \
  --data '{"computers":[101,202,303]}'

Sample Request Body

Copied!
  {
    "computers": [
      101,
      202,
      303
    ]
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
loggedOnUsersarray

Array of computer objects with resourceId, computerName, and a nested users array containing userName and domainName

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "loggedOnUsers": [
      {
        "resourceId": 101,
        "computerName": "WIN-DESKTOP-01",
        "users": [
          {
            "domainName": "CORP",
            "userName": "john.doe"
          }
        ]
      }
    ]
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.