v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

User

Create User

Add User

This endpoint allows the client to add a new user by sending a POST request to the specified URL.

Request Body

username (string): The username of the user.
password (string): The password for the user account.
email (string): The email address of the user.
sip_option (string): The SIP option for the user.
is_active (string): Indicates whether the user account is active.
reset_password (string): Indicates whether the user should reset their password.
sip_uri (string): The SIP URI for the user.
use_extended_ip_acl (string): Indicates the usage of extended IP ACL.
user_route_caller_id (string): The caller ID for user routing.
member_all_desks (string): Indicates membership to all desks.
desks (array): An array of desks associated with the user.
roles (array): An array of roles assigned to the user.

post/users

Request body

is_activestring

{"stackTrail":"paths:/users:post:requestBody:content:application/json:schema:properties:kerb_username","oasType":"schema","type":"unknown","example":null,"nullable":true}

passwordstring

reset_passwordstring

sip_optionstring

{"stackTrail":"paths:/users:post:requestBody:content:application/json:schema:properties:sip_uri","oasType":"schema","type":"unknown","example":null,"nullable":true}

use_extended_ip_aclstring

usernamestring

Example request

{
  "is_active": "1",
  "password": "kh3d5f67g7k8j8f8g8k8fjg",
  "reset_password": "0",
  "sip_option": "0",
  "use_extended_ip_acl": "0",
  "username": "Klarisa"
}

Response

Successful operation

Example response

{
  "users": [
    {
      "auto_dial": "2",
      "default_language": null,
      "desks": {
        "1": "TAG1_MaskedPhone"
      },
      "email": "test@test.com",
      "first_name": "",
      "id": "1",
      "is_active": "1",
      "is_deleted": "0",
      "last_name": "",
      "max_concurrent_sessions": "0",
      "max_session_time": "0",
      "member_all_desks": "0",
      "registration_password": "ksjdgk632412",
      "roles": {
        "1": "Admins"
      },
      "sip_uri": null,
      "timezone_id": null,
      "twofa_type": "default",
      "use_extended_ip_acl": "0",
      "use_webrtc": "0",
      "user_region": "0",
      "username": "Klarisa",
      "virtual_extension": null
    }
  ]
}