SIP Authentication

Display user’s SIP authentication parameters

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

Retrieve the user’s SIP authentication parameters.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/authentication/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "userName": "ApioUserTest"
}

Response JSON Object:

• userName (string) – the user’s SIP authentication user name.

Status Codes:

• 200 OK – no error

Update user’s SIP authentication password and/or username

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

Update the user’s SIP authentication password and/or username.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/authentication/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "userName": "ApioUserTest",
   "newPassword": "NewPassword",
   "oldPassword": "OldPassword"
}

Request JSON Object:

• userName (string) – (Optional) the new user’s SIP authentication user name to be set.

• newPassword (string) – (Mandatory only if ‘oldPassword’ is present, Optional otherwise) the new user’s SIP authentication password to be set. If empty, a new SIP password will be generated automatically, if APIO is configured to do so.

• oldPassword (string) – (If ‘newPassword’ is present: Mandatory at USER level, Optional at other levels) must match the user’s current SIP authentication password.

Example response:

HTTP/1.1 200 OK

Status Codes:

• 200 OK – no error

• 400 Bad Request – invalid data, oldPassword doesn’t match the current one or oldPassword missing (last one only possible at USER level)