Instant Messaging & Presence¶

Display user’s instant messaging & presence¶

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

Retrieve the settings of the Instant Messaging & Presence service of the user.

Example request:

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

Example response:

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

{
     "active": false
}

Response JSON Object:

active (boolean) – the status of the service.

Status Codes:

200 OK – no error
404 Not Found – service is not assigned to this user

Update a user’s instant messaging & presence¶

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

Update the settings of the Instant Messaging & Presence service of the user.

Example request:

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

{
     "active": true
}

Request JSON Object:

active (boolean) – the status of the service.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request – invalid data
404 Not Found – service is not assigned to this user

Generate a new user’s instant messaging & presence password¶

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

Generate a new password for the Instant Messaging & Presence service of the user.

Example request:

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

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request – invalid data or service not active
404 Not Found – service is not assigned to this user