Skip to main content

Auth

Provides authorization credentials for chat assistant clients.

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs​

  • Session Id - Unique identifier for the UI client connection.
  • Label - Optional label for the authorization widget.
  • Description - Optional description for the authorization widget.

Options​

  • Authorization Mode - Specifies the authorization mode for clients. Can be either "Basic Auth" or "Password Only".

Output​

  • Result - Authorization credentials received from the client.

How It Works​

The Auth node creates an authorization widget that is displayed to the client and waits for the client to provide their credentials. When executed, the node:

  1. Validates the provided Session ID
  2. Creates an authorization widget with the specified label and description
  3. Sends the widget to the client with the specified session ID
  4. Waits for the client's response
  5. Parses the response as JSON or string
  6. Returns the parsed credentials as the result

Requirements​

  • A valid session ID for an active client connection
  • Properly configured client interface that can handle authorization widgets

Error Handling​

The node will return specific errors in the following cases:

  • Empty or invalid Session ID
  • Session not found for the provided ID
  • Failed to send authorization widget to client
  • Timeout while waiting for client response
  • Failed to parse client response

Usage Notes​

  • The Session ID must match an active client connection
  • The Label and Description fields are optional but can help users understand what credentials are being requested
  • The Authorization Mode determines how the client interface presents the authorization request
  • The returned credentials will be in the format provided by the client (JSON or string)