Create a client

Step-by-step guide to creating MQTT client credentials in the CloudSignal dashboard.

This guide walks you through creating MQTT client credentials that your applications and services use to connect.

Prerequisites

Logged into the CloudSignal dashboard.
Access to a workspace (a default workspace is created automatically).

Navigate to Clients

Log into the CloudSignal dashboard.
Click Clients in the sidebar under Connections.

Click Create Client

Click the Create Client button in the top right corner.

Enter client details

Fill in the form:

Field	Description	Example
Username	Identifier for this credential (alphanumeric, hyphens allowed)	`agent-001`
Password	Strong password for authentication	Use generated or create your own
Workspace	Which workspace this user belongs to	Default workspace

Username tips: use descriptive names like mobile-app, backend-service, or agent-research. Keep them lowercase and use hyphens instead of spaces.

Save and copy credentials

Click Create to save.
Copy the password now. It won't be shown again.
Note your Organization ID (found in Settings → Organization).

Construct the full username

To connect, you need the full username format:

username@organization_id

For example:

Username you created: agent-001
Your organization ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Full username for connection: agent-001@a1b2c3d4-e5f6-7890-abcd-ef1234567890

Connection example

Once you have your credentials, connect like this:

JavaScript

const mqtt = require('mqtt');

const client = mqtt.connect('mqtts://mqtt.cloudsignal.app:8883', {
  username: 'agent-001@a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  password: 'your-password-here',
});

Python

import paho.mqtt.client as mqtt
import ssl

client = mqtt.Client()
client.username_pw_set(
    'agent-001@a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'your-password-here',
)
client.tls_set(cert_reqs=ssl.CERT_REQUIRED)
client.connect('mqtt.cloudsignal.app', 8883)

Managing clients

Edit a client

Go to Clients.
Click on the client row.
Modify details and save.

Reset password

Go to Clients.
Click on the client.
Click Reset Password.
Set the new password and save.

Delete a client

Go to Clients.
Click on the client.
Click Delete.
Confirm deletion.

Deleting a client immediately disconnects any active sessions using those credentials.

Best practices

One client per app or service

Pattern	Example
Recommended	`agent-research`, `agent-orchestrator`, `mobile-app-ios`, `backend-processor`
Anti-pattern	`shared-account` reused across many clients

Naming conventions

Use consistent naming that identifies the purpose:

{type}-{identifier}

Examples:
  agent-research-01
  worker-task-runner
  app-mobile-user-123
  service-notification

Environment separation

Create different clients for different environments:

dev-agent-001     (development workspace)
staging-agent-001 (staging workspace)
prod-agent-001    (production workspace)

Next steps

Understand the username format - Why @organization_id is required
Make your first connection - Test your new credentials
Set up ACL rules - Control what this client can access

On this page