logout

The logout command signs the current user out of the session.

Command Type	DisplayNet
Minimum Version	2.x.x

Usage

logout

Return value

The reply is a DN_AUTHENTICATION message carrying the session's new identity.

When the server does not require authentication, the session is signed back in as the built-in DisplayNet user rather than left unauthenticated:

logout, on a server that does not require authentication
{
  "status": "DN_AUTHENTICATION",
  "request_id": null,
  "result": null,
  "error": null,
  "auth_details": {
    "IsAuthenticated": true,
    "UserName": "DisplayNet",
    "UserFullName": "DisplayNet",
    "Role": "User",
    "ClientAddress": "127.0.0.1:51684",
    "AuthState": "COMPLETE",
    "AuthenticationDateTime": "2026-07-31T22:55:00.9897486Z",
    "ConnectionType": "Socket",
    "LoginToken": ""
  }
}

When authentication is required, IsAuthenticated is false and AuthState is RETRY; the session must log in again before sending further commands.

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/logout. This one has its own endpoint and cannot be named in a request body.
Role	—

Operation	Parameters
logout	—

See also

• login: authenticate a session
• Connection State: the DN_AUTHENTICATION reply and its members