Skip to main content
Manage SIP credentials for username/password authentication on your trunks.

Introduction

Credentials provide username/password-based authentication for your SIP trunks. Each credential consists of a unique username and password combination that SIP clients can use to authenticate when making or receiving calls through your trunk. Multiple credentials can be created for a single trunk, allowing different users, devices, or applications to connect with separate authentication details. This provides flexibility in managing access and tracking usage across different endpoints. Credential trunks are challenged with 407 Proxy Authentication Required; answer with a Proxy-Authorization header. 401 Unauthorized is used only for REGISTER.
Security Note: Passwords are write-only and never returned in API responses. Once set, passwords cannot be retrieved - only updated or reset.Best Practice: Use strong passwords (minimum 8 characters) with a mix of uppercase, lowercase, numbers, and special characters. Rotate credentials regularly for enhanced security.

Use Cases

  • Dynamic IP environments - Perfect for remote workers, mobile devices, or any scenario where the source IP address changes frequently. Username/password authentication works regardless of network location.
  • Multi-user access - Create separate credentials for different users or departments, making it easier to track usage and manage access permissions independently.
  • SIP client integration - Configure softphones, desk phones, or PBX systems with unique credentials for reliable authentication without IP whitelisting requirements.
  • Combined authentication - Use credentials alongside IP ACL for maximum security - requiring both valid credentials AND whitelisted IP addresses for authentication.

Available Operations

  1. The Credential Object - Learn about the structure and attributes of credential objects
  2. Create Credential - Add new SIP credentials to a trunk with username and password
  3. Retrieve All Credentials - List all credentials associated with a trunk with pagination support
  4. Update Credential - Modify existing credential properties like password, status, or description
  5. Delete Credential - Permanently remove credentials from a trunk
Quick Start: Begin by reviewing the credential object structure, then create your first credential to start authenticating SIP clients to your trunk.