Users

Retrieve an user

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/

The API is mapped to UserGetRequest.

Additional informations

Response JSON Object:

  • isAdmin (boolean) – Not supported by Broadsoft.

  • trunkEndpoint (object) – A trunk endpoint as defined in Trunk Endpoint.

Update an user

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/

The API is mapped to UserModifyRequest.

Additional restrictions

Request JSON Object:

  • isAdmin (boolean) – Not supported by Broadsoft.

  • trunkEndpoint (object) – A trunk endpoint as defined in Trunk Endpoint.

Additional restrictions

Request JSON Object:

  • callingLineIdLastName (string) – It is not allowed to contain characters %, +, backslash, double quotes, or extended ascii characters.

  • callingLineIdFirstName (string) – It is not allowed to contain characters %, +, backslash, double quotes, or extended ascii characters.

Delete an user

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/

The API is mapped to UserDeleteRequest