Users

Last modified by michaely on 2021/09/10 23:34

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

The information on this page applies to iSymphony 3.2+.

Description

The live user REST resource allows access to information about the state of users in the system. There are currently no actions that can be performed on a user.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

JSON Representation

{
"id": "cb250fe1-a20d-4cf8-a4c2-a8454fd5fc4f",
"configurationId": "ed38fe4d-13ad-4fd0-be25-d3404c421370",
"userName": "4224",
"displayedName": "Michael Y (desk)",
"permissionId": "ed38fe4d-13ad-4fd0-be25-d3404c421370"
}

Property	Type	Description
id	String	The id of the user.
configurationId	String	The id of the configuration object that represents the user.
userName	String	The username of the user.
displayedName	String	The display name of the user.
permissionId	String	The user's permission id.

Root Resource Paths

Paths used to access sets of the resource, in relation to parent resources.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users
Description	Provides access to all users in the specified core server. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets all users in the specified core server.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{user_id}
Description	Provides access to a specific user, by user id. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above user_id: the id of the user to access Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no user with the given id exists
GET	Gets the specified user.

{root_resource_path}/getByName/{username}
Description	Provides access to a specific user, by username. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above username: the username of the user to access Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no user with the given username exists
GET	Gets the specified user.

Sub Resource Paths

Paths used to access the child resources of this resource.

{instance_resource_path}/logins
Description	Provides access to the active logins for the specified user. See Logins. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
GET	Gets all active logins for the specified user.

{instance_resource_path}/status
Description	Provides access to the status of the specified user. See Status. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
GET	Get the status of the specified user.

{instance_resource_path}/extensions
Description	Provides access to the extensions of the specified user. See Extensions. Information Excludes any extensions that are not bound to a licensed/full user. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found

Curl Examples

Gets all users in a core server

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users

Gets a specific user in a core server

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/4aff6119-54e8-4884-bff6-f76c7dddf74b