Administrator Configuration

Version 16.1 by michaely on 2016/05/28 21:37

For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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.1+.

Description

The administrator REST resource allows access to the configuration for system administrators.

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.

Root Resource Path

communication_manager/rest/config/server/administrators

JSON Representation

{
"id": "ee828da8-5ee6-413d-82ac-1273f598659d",
"userName": "admin",
"password": "d36c07e15f98bea42b1cd80bca5b5ce4d9131c68",
"superUser": true
}

Property	Type	Description
id	String	Configuration id of the administrator.
userName	String	Username of the Administrator.
password	String	SHA-1 hash of the administrators password.
superUser	Boolean	Flags specifiying if the administrator is a super admin.

Resource Paths

communication_manager/rest/config/server/administrators
Description	Accesses all the administrators in the system.
GET	Gets all the administrators in the system.
POST	Adds an administrator to the configuration. Errors: 409 'An administrator with the given id already exists.': Returned if an administrator with the given id already exists. 409 'An administrator with the given username already exists.': Returned if an administrator with the given username already exists.

communication_manager/rest/config/server/administrators/{id}
Description	Accesses the configuration model for the specified core server. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
GET	Gets the chat configuration model for the specified core server.

Sub/Child Resource Paths

communication_manager/api/resource/core/{core_server_id}/users
Description	Access the sub/child resource for users, in a specified core server, via the core server id. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id. See User Configuration for more information.

communication_manager/api/resource/core/{core_server_id}/statuses
Description	Access the sub/child resource for statuses, in a specified core server via the via the core server id. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id. See User Configuration for more information.

communication_manager/api/resource/core/{core_server_id}/userGroups
Description	Access the sub/child resource for user groups, in a specified core server via the via the core server id. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id. See User Group Configuration for more information.

communication_manager/api/resource/core/{core_server_id}/permissions
Description	Access the sub/child resource for permissions, in a specified core server via the via the core server id. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id. See Permissions Configuration for more information.

communication_manager/api/resource/core/{core_server_id}/authToken
Description	Access the sub/child resource for creating authentication tokens, via the core server id. For JSON used to in the request and response for this resource see Session Authentication Token above. Parameters: core_server_id: The UUID of the core server. Errors: 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id. See Authentication Tokens for more information.

Curl Examples

Get configuration for all core servers

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core

Get the configuration for a specific core server

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7

Request an authentication session token

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"username":"johnd","password":"pass"}' http://localhost:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/authToken