Page tree
Skip to end of metadata
Go to start of metadata

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. This resource allows adding, removing, and updating of administrators in the system.

 

On this page:

 

Root Resource Path

communication_manager/rest/config/server/administrators

JSON Representation

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

Configuration id of the administrator.

userNameStringUsername of the Administrator.
passwordStringSHA-1 hash of the administrators password.
superUserBooleanFlags specifying if the administrator is a super admin.

Resource Paths

communication_manager/rest/config/server/administrators
DescriptionAccesses all the administrators in the system.
GET Gets all the administrators in the system.
POST

Adds an administrator to the configuration.

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.
  • 412 'No username provided.': Returned if no username was provided.
  • 412 'No password provided.': Returned if no password was provided.
 
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.

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.
  • 412 'No username provided.': Returned if no username was provided.
  • 412 '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.

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 administrator.

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
  • No labels