Retrieves logged-on users for the given computers for selective logoff operations 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
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Content-Type string Mandatory
- Request Body application/json 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]}'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/tools/shutdown/getLoggedOnUsers"))
.header("Content-Type", "application/getLoggedOnUsersParams.v1+json")
.header("Accept", "application/loggedOnUsersList.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"computers\":[101,202,303]}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"computers\":[101,202,303]}"
headers = {
'Content-Type': "application/getLoggedOnUsersParams.v1+json",
'Accept': "application/loggedOnUsersList.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/dcapi/tools/shutdown/getLoggedOnUsers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/loggedOnUsersList.v1+json");
headersMap.put("Content-Type", "application/getLoggedOnUsersParams.v1+json");
data=Map();
data_computers=List();
data_computers.add("value");
data.put("computers",data_computers);
response = invokeUrl
[
url: "https://appDomain/dcapi/tools/shutdown/getLoggedOnUsers"
type: POST
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Content-Type", "application/getLoggedOnUsersParams.v1+json")
$headers.Add("Accept", "application/loggedOnUsersList.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/shutdown/getLoggedOnUsers' -Method POST -Headers $headers -ContentType 'application/getLoggedOnUsersParams.v1+json' -Body '{"computers":[101,202,303]}'Sample Request Body {
"computers": [
101,
202,
303
]
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes loggedOnUsers array
Array of computer objects with resourceId, computerName, and a nested users array containing userName and domainName
Possible Response Codes Sample Response: HTTP 200 {
"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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.