Skip to main content

Authentication

Learn how to authenticate and manage your Signaloid CLI credentials.

Authentication methods​

Signaloid CLI supports two authentication methods:

  1. API Key (Recommended) - Use a Signaloid API key
  2. Email/Password - Use your Signaloid account credentials

API key authentication​

Getting an API key​

  1. Log in to signaloid.io
  2. Navigate to Settings → Cloud Engine API
  3. Click "Generate New Key"
  4. Copy the key immediately (you will not be able to see it again)

Login with API key​

signaloid-cli auth login --api-key YOUR_API_KEY

Example:

signaloid-cli auth login --api-key scce_1234567890abcdef

Output:

✔ API key authenticated
Hello!
Recommended Method

API keys are the recommended authentication method because they:

  • Do not require storing passwords
  • Can be easily revoked if compromised
  • Are more secure for automation and CI/CD

Email/password authentication​

Provide credentials via command-line options:

signaloid-cli auth login --email john.doe@example.com --password YOUR_PASSWORD
Security Consideration

Using passwords in command-line arguments may expose them in shell history. Use API keys for better security, especially in scripts.

Managing authentication​

Check current user​

Verify who you are logged in as:

signaloid-cli auth whoami

Output:

{
  "id": "user_abc123",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "created": "2025-01-01T00:00:00Z"
}

Logout​

Clear your local authentication:

signaloid-cli auth logout

Output:

✔ Logged out locally
What Happens on Logout?
  • API key mode: Removes stored API key from config
  • User/password mode: Logs out from server AND removes local config

Environment variables​

Override config directory​

Set a custom location for the config file:

export SIGNALOID_CONFIG_DIR=/path/to/config
signaloid-cli auth login --api-key YOUR_KEY

Use API key from environment​

Store your API key in an environment variable:

export SIGNALOID_API_KEY="scce_1234567890abcdef"
signaloid-cli auth login --api-key $SIGNALOID_API_KEY

Multiple accounts​

Switching between accounts​

To switch accounts, simply log out and log back in:

# Logout from current account
signaloid-cli auth logout

# Login with different credentials
signaloid-cli auth login --api-key DIFFERENT_API_KEY

Security best practices​

Do ✓​

  • ✓ Use API keys instead of passwords for automation
  • ✓ Store API keys in environment variables or secrets managers
  • ✓ Rotate API keys regularly
  • ✓ Use different API keys for different environments (dev/staging/prod)
  • ✓ Revoke unused or old API keys

Do not ✗​

  • ✗ Do not commit API keys to version control
  • ✗ Do not share API keys in chat or email
  • ✗ Do not use production API keys in development
  • ✗ Do not log API keys in application output
  • ✗ Do not store API keys in plain text files

Revoking API keys​

If an API key is compromised:

  1. Go to signaloid.io/settings/api
  2. Find the compromised key
  3. Click "Revoke"
  4. Generate a new key
  5. Update all systems using the old key

Config file structure​

The config file contains:

{
  "profile": "default",
  "env": "production",
  "apiEndpoint": "https://api.signaloid.io",
  "auth": {
    "mode": "apikey",
    "apiKey": "scce_1234567890abcdef"
  }
}

Never manually edit the config file unless you know what you are doing. Use the auth commands instead.

Next steps​

Need Help?

If you are having authentication issues, contact support at developer-support@signaloid.com.

Last updated on