Skip to navigation

Authentication Status

View as MarkdownOpen in Claude

When initially connecting to the websocket endpoint, an authentication status message with the topic sts is sent automatically to relay the current authentication state of the user. Additional sts messages are delivered whenever the authentication state changes, such as when a competing session is detected.

Response

Properties

topic
stringRequired

Returns the topic of the message. Returns "sts".

args
objectRequired

Object containing the authentication status details.

authenticated
booleanRequired

Indicates whether the user is currently authenticated to the brokerage session.

{"topic":"sts","args":{"authenticated":true}}