Disconnect user
Disconnects all sessions for the given user account. A disconnected user can no longer issue commands and must log in again to do so.
Request syntax
POST
/v1/authentication/sessions/{name}/disconnect {"reason": <reason>}
Disconnects all sessions for the given user account.
Path parameters
name
(string)-
The unique name of the user account.
Request body parameters
reason
(string, optional)-
The reason the disconnect is occurring. This is transmitted to the disconnected user as an explanation of what happened.
Example
> POST /v1/authentication/loggedInUsers/admin5/disconnect
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0