Quick Reference
Here’s a quick overview of all available authentication commands:Authentication Methods
CLI Login
Authenticate using the Compozy CLI for local development and deployments.
API Keys
Use API keys for programmatic access and CI/CD integrations.
CLI Authentication
Login Command
Use the following command to authenticate with Compozy Cloud:This will open your default browser to complete the authentication process.
Verify Authentication
Confirm your authentication status:
Logout
To logout and remove stored credentials:
API Keys
API keys provide secure, programmatic access to Compozy services. They are especially useful for CI/CD pipelines and automated deployments.Generate API Key
- Visit the Compozy Cloud Dashboard
- Navigate to Settings > API Keys
- Click “Generate New Key”
- Save the key securely - it won’t be shown again
Configure API Key
Set your API key using one of these methods:
Key Management
Best practices for API key security:
- Rotate keys regularly
- Use different keys for different environments
- Never commit keys to version control
- Set appropriate key permissions and expiration
CI/CD Integration
For secure authentication in CI/CD pipelines:Token Management
View Active Sessions
List all active authentication sessions:
Revoke Access
Revoke specific tokens or all active sessions:
Token Refresh
Tokens are automatically refreshed when needed. Manual refresh:
Security Best Practices
Credential Storage
- Use environment variables for API keys
- Leverage secure credential managers
- Never hardcode credentials in code
Access Control
- Follow the principle of least privilege
- Regularly audit access permissions
- Remove unused credentials promptly
Environment Separation
- Use different credentials per environment
- Implement proper key rotation policies
- Monitor credential usage patterns
Troubleshooting
Invalid Credentials
Invalid Credentials
- Verify your API key is correctly set
- Check for environment variable conflicts
- Ensure your token hasn’t expired
- Try logging out and back in
Authentication Failures
Authentication Failures
- Check your network connection
- Verify your system time is accurate
- Clear local credential cache
- Contact support if issues persist
Token Expiration
Token Expiration
- Tokens automatically refresh when needed
- Manual refresh with
compozy auth refresh - Generate new API key if expired
- Check token expiration status
Need Help?
- Run
compozy auth --helpfor detailed command information - Visit our Discord community for support
- Check our troubleshooting guide
- Contact Compozy Support for assistance