Alternate User Ids¶

Retrieve User’s Alternate Id List¶

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

Retrieve the list of Alternate Ids of the User.

Example request:

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

{}

Example response:

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

{
   "alternateUserIds": [
      {
         "alternateUserId": "alternateId_1@sip.netaxis.be",
         "description": "description 1"
      }
   ]
}

Response JSON Object:

userIds (array) – a list of alternate user ids as defined as Alternate User Id attributes.

Status Codes:

200 OK – no error

Create a User’s Alternate Id¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/¶

Create an User’s Alternate Id.

In case the input alternateUserId is provided without domain, the Group default domain will be appended to it to have a full user id with domain.

Example request:

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

{
   "alternateUserId": "alternateId_1",
   "description": "test description"
}

Request JSON Object:

alternateUserId (string) – the alternateUserId.
description (string) – (optional) the description.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
400 Bad Request – error during the creation
404 Not Found – service not assigned to the User. User not found.

Retrieve an User’s Alternate Id¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/¶

Retrieve an User’s Alternate Id.

In case the input instance_name is provided without domain, the Group default domain will be appended to it to have a full user id with domain.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_user_ids/alternateId_1@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{}

Example response:

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

{
   "alternateUserId": "alternateId_1@sip.netaxis.be",
   "description": "test description"
}

Response JSON Object:

alternateUserId (string) – the alternateUserId.
description (string) – the description.

Status Codes:

200 OK – no error
400 Bad Request – error during the update
404 Not Found – service not assigned to the User. User not found. Alternate User Id (instance_name) not found.

Update a user’s Alternate User Id¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/¶

Update an User’s Alternate Id.

In case the input alternateUserId is provided without domain, the Group default domain will be appended to it to have a full user id with domain.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/alternate_user_ids/alternateId_1@sip.netaxis.be/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "alternateUserId": "alternateId_modified",
   "description": "test description modified"
}

Request JSON Object:

alternateUserId (string) – (optional) the new alternateUserId.
description (string) – (optional) the new description.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
400 Bad Request – error during the update
404 Not Found – service not assigned to the User. User not found. Old Alternate User Id (instance_name) not found.

Delete a user’s Alternate User Id¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/alternate_user_ids/(string: instance_name)/¶

Delete an User’s Alternate Id.

In case the input instance_name is provided without domain, the Group default domain will be appended to it to have a full user id with domain.

Example request:

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

{}

Example response:

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

{}

Status Codes:

200 OK – no error
404 Not Found – service not assigned to the User. User not found.

Alternate User Id attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
alternateUserId	String	A	The Alternate User Id.
description	String	A	The description.