The Credential Object
Complete structure and attributes of a SIP Credential object.
The Credential object represents a set of SIP authentication credentials (username and password) that can be used to authenticate calls on a specific trunk. Multiple credentials can exist for a single trunk, enabling different users, devices, or applications to connect with unique authentication details.
Password Security: The password field is write-only and will never be returned in API responses. Once created, passwords cannot be retrieved - only updated.
Username Immutability: The username cannot be changed after credential creation. To use a different username, create a new credential and delete the old one.
Attributes
Credential Attributes
| Parameter | Type | Description |
|---|---|---|
idoptional | string (UUID) | Unique identifier for the credential. Automatically generated upon creation. |
trunk_idoptional | string (UUID) | The ID of the trunk this credential belongs to. |
usernameoptional | string | SIP username for authentication. Required field. Must be unique within the trunk. Cannot be changed after creation. |
passwordoptional | string | SIP password for authentication. Required field (minimum 8 characters). Write-only - never returned in responses. |
enabledoptional | boolean | Whether the credential is active and can be used for authentication. Default: true. |
descriptionoptional | string | Optional description providing context about the credential's purpose or which device/user it belongs to. |
created_atoptional | string (ISO 8601) | Timestamp when the credential was created. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
updated_atoptional | string (ISO 8601) | Timestamp of the last update to the credential. Format: YYYY-MM-DDTHH:mm:ssZ (UTC timezone). |
Example
Credential Object Response
A typical credential object as returned by the API (note: password is not included):
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"trunk_id": "bfab10fb-cb97-488b-9c63-989c32980b0f",
"username": "trunk_user_001",
"enabled": true,
"description": "Primary trunk credential for production",
"created_at": "2025-01-15T10:35:20Z",
"updated_at": "2025-01-15T10:35:20Z"
}Security Best Practices:
- • Use strong passwords with at least 12 characters
- • Include uppercase, lowercase, numbers, and special characters
- • Rotate credentials regularly (quarterly recommended)
- • Disable unused credentials immediately rather than deleting them
- • Use descriptive usernames that identify the device or user