LogOut

Category: Authentication Permissions: Public Call Type: Synchronous

LogOut ends the current websocket session.

Request

There is no payload for a LogOut request.

{ }

Response

{
  "result":true,
  "errormsg":null,
  "errorcode":0,
  "detail":null
}

Key	Value
result	Boolean. A successful logout returns true; an unsuccessful logout (an error condition) returns false.
errormsg	string. A successful logout returns null; the errormsg parameter for an unsuccessful logout returns one of the following messages: Not Authorized (errorcode 20) Invalid Response (errorcode 100) Operation Failed (errorcode 101) Server Error (errorcode 102) Resource Not Found (errorcode 104) Not Authorized and Resource Not Found are unlikely errors for a LogOut.
errorcode	integer. A successful logout returns 0. An unsuccessful logout returns one of the errorcodes shown in the errormsg list.
detail	string. Message text that the system may send. Usually null.

Key

Value

result

Boolean. A successful logout returns true; an unsuccessful logout (an error condition) returns false.

errormsg

string. A successful logout returns null; the errormsg parameter for an unsuccessful logout returns one of the following messages: Not Authorized (errorcode 20) Invalid Response (errorcode 100) Operation Failed (errorcode 101) Server Error (errorcode 102) Resource Not Found (errorcode 104) Not Authorized and Resource Not Found are unlikely errors for a LogOut.

errorcode

integer. A successful logout returns 0. An unsuccessful logout returns one of the errorcodes shown in the errormsg list.

detail

string. Message text that the system may send. Usually null.

PreviousGetValidate2FARequiredEndpoints NextRegisterNewDevice

Last updated 4 months ago