Administrator Configuration

Version 15.1 by michaely on 2016/05/28 22:08

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 specifying 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. Information This resource URL will take in a plain text password for the administrator and create a SHA-1 hashed version of it in the configuration. If you want to pass in a pre-hashed version of the password that will be stored without modification you can use the following URL instead: communication_manager/rest/config/server/administrators/noHash 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 of a specific administrator. Parameters: id: The configuration id of the administrator.
GET	Gets the configuration of the specified administrator. Errors: 404 'An administrator with the given id does not exist': Returned if no administrator exists with the given id.
PUT	Updates the specified administrator configuration. Information This resource URL will take in a plain text password for the administrator and create a SHA-1 hashed version of it in the configuration. If you want to pass in a pre-hashed version of the password that will be stored without modification you can use the following URL instead: communication_manager/rest/config/server/administrators/noHash/{id} Errors: 404 'An administrator with the given id does not exist': Returned if no administrator exists with the given id. 409 'An administrator with the given username already exists.': Returned if an administrator with the given username already exists. 409 'No username provided.': Returned if no username was provided. 409 'No password provided.': Returned if no password was provided.
DELETE	Deletes the specified administrator configuration. Errors: 404 'An administrator with the given id does not exist': Returned if no administrator exists with the given id. 409 'No username provided.': Returned if no username was provided. 409 'No password provided.': Returned if no password was provided.

Sub/Child Resource Paths

communication_manager/rest/config/server/administrators/{id}/managedCoreServers
Description	Access the sub/child resource for the Core Server Instances that are are managed by the specified administrators. Parameters: id: The configuration id of the administrator. Errors: 404 'An administrator with the given id does not exist': Returned if no administrator exists with the given id.

Curl Examples

Get all administrators

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/administrators

Get the configuration for a specific administrator

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-413d-82ac-1273f598659d

Add a new administrator

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id": "ee828da8-5ee6-412d-82ac-1273f598659d", "userName": "newAdmin", "password": "d36c07e12f98bea42b1cd80bca5b5ce4d6131c68", "superUser": true}' http://localhost:58080/communication_manager/rest/config/server/administrators

Delete an administrator

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-412d-82ac-1273f598659d

Update an administrator

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id": "ee828da8-5ee6-412d-82ac-1273f598659d", "userName": "newAdmin", "password": "d36c07e12f98bea42b1cd80bca5b5ce4d6131c68", "superUser": false}' http://localhost:58080/communication_manager/rest/config/server/administrators/ee828da8-5ee6-412d-82ac-1273f598659d