Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The tenant API key that POST /bootstrap returned.

Path Parameters

id
string
required

The upstream ID.

Body

application/json
username
string
required

The SIP user that apps register as and authenticate to pgw with, without control characters. It can't change.

Required string length: 1 - 128
password
string
required
write-only
Required string length: 1 - 256
domain
string

The domain that the user's apps register to: the upstream's host or a name that its domains serve. Required on an upstream with domains, and refused with 400 on any other. pgw stores it in lower case without a trailing dot. It can't change. 1001 at two domains is two users.

Example:

"acme.example.com"

auth_username
string

The digest username that pgw answers the PBX with, when the PBX knows the account by another name than username. Apps still authenticate to pgw as username.

Maximum string length: 128
enabled
boolean
default:true

Response

The user.

id
string
required
upstream_id
string
required
username
string
required
enabled
boolean
required
last_seen_at
string<date-time>
required

When a device last registered as this user, or when the user was created if none has.

created_at
string<date-time>
required
domain
string

Absent on an upstream without domains.

auth_username
string

Absent when pgw answers the PBX with the username.