(408) 943-4100               V   Commercial Support

rpc/auth_clear

  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates Event
rpcauth_clearN/AN/AN/A

Description

Logout of an existing session. This will invalidate any existing auth tokens for the user session and close down the websocket connection.

Input Arguments

  • Required:
    • none ({})
  • Optional:
    • none ({})

Request Example Arguments

{
  "namespace" : "rpc",
  "name" : "auth_clear",
  "id" : "some_id",
  "args" : {}
}

Reply Example

There is no reply. The server responds by closing the websocket connection after invalidating any outstanding auth tokens and closing the current session (nearly-instant action).

Log Summary

This API call does not generate a detailed log summary item

Events

This API call does not emit any middleware events.

See Also