v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

User

Update User

Update User Details

This endpoint allows the client to update the details of a specific user.

Request Body Parameters

id (number): The unique identifier of the user.
username (string): The username of the user.
email (string): The email address of the user.
is_active (number): Indicates if the user is active.
sip_uri (string): The SIP URI of the user.
is_deleted (number): Indicates if the user is deleted.
use_extended_ip_acl (number): Indicates if the user uses extended IP ACL.
timezone_id (number): The timezone identifier for the user.
first_name (string): The first name of the user.
last_name (string): The last name of the user.
virtual_extension (string): The virtual extension of the user.
default_language (string): The default language for the user.
- en_US - English (United States)
- es_ES - Spanish (Spain)
- pt_BR - Portuguese (Brazil)
max_session_time (string): The maximum session time for the user.
max_concurrent_sessions (string): The maximum concurrent sessions for the user.
twofa_type (string): The two-factor authentication type for the user.
- default - Default from Role / Tenant
- disabled - Disabled - login without 2FA
- email - Email - with one-time code
- google - Google 2FA App - with one-time code
member_all_desks (string): Indicates if the user is a member of all desks.
use_webrtc (number): Indicates if the user uses WebRTC.

put/users/{id}

Request body

default_languagestring

emailstring

is_activenumber

is_deletednumber

max_concurrent_sessionsnumber

max_session_timestring

member_all_desksboolean

member_all_skill_groupsstring

sip_uristring

twofa_typestring

use_extended_ip_aclstring

use_webrtcnumber

user_regionstring

usernamestring

virtual_extensionstring

Example request

{
  "default_language": "en_US",
  "email": "trunkqa@commpeak.com",
  "max_concurrent_sessions": 10,
  "max_session_time": "3600",
  "member_all_skill_groups": "string",
  "sip_uri": "user/trunkqa@dev2pbx.pbx.commpeak.com",
  "twofa_type": "string",
  "use_extended_ip_acl": "1.2.3.4/32",
  "user_region": "0",
  "username": "trunkqa",
  "virtual_extension": "713"
}

Response

Successful operation

Example response

{
  "users": [
    {
      "auto_dial": "0",
      "default_language": "en_US",
      "desks": {
        "1": "Main Desk"
      },
      "email": "trunkqa@commpeak.com",
      "first_name": "",
      "id": "5",
      "is_active": "0",
      "is_deleted": "0",
      "last_name": "",
      "max_concurrent_sessions": "10",
      "max_session_time": "3600",
      "member_all_desks": "0",
      "registration_password": "bda4f8bdd15cb42bc159cb5aed261801",
      "roles": {
        "2": "PBX_AGENT"
      },
      "sip_option": "3",
      "sip_uri": "user/trunkqa@example.pbx.commpeak.com",
      "timezone_id": "0",
      "twofa_type": "default",
      "use_extended_ip_acl": "12",
      "use_webrtc": "0",
      "user_region": "0",
      "username": "trunkqa",
      "virtual_extension": "713"
    }
  ]
}