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 Asterisk extension group editors REST resource allows access to the users that are marked as editors of the group. This resource allows adding and removing of editor users to and from the group.

 

On this page:

 

Root Resource Path

communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/editors

JSON Representation

{
  "id": "56cf70a3-1ee0-4b09-8f40-297430eeeddf",
  "username": "4224",
  "password": "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4",
  "enabled": true,
  "full": true,
  "displayName": "Steve S",
  "lastPasswordChangedAt": null,
  "permissionDisplayName": "Steve S",
  "permissionId": "56cf70a3-1ee0-4b09-8f40-297430eeeddf"
}
PropertyTypeDescription
id
String

Configuration id of the user.

usernameStringUsername of the user.
passwordStringSHA-1 hash of the user's password.
enabledBooleanFlag specifying if the user is enabled.
fullBooleanFlag specifying if the user is a full or lite user.
displayNameStringThe display name for the user.
lastPasswordChangedAt
LongThe last time the user changed their password from the client interface. Represented as a Unix timestamp in milliseconds. Can be null.
permissionDisplayName
StringDisplay name of the user in the permission system.
permissionId
StringPermission id of the user.

Resource Paths

communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/editors
DescriptionAccesses all the users that are marked as editors of the group.
GET Gets all the configuration for all the users that are makred as editors of the group.
POST

Adds a user as a editor of the extension group.

Errors:

  • 409 'The specified editor already exists in the extension group.': Returned if the user is already a editor in the extension group.
 
communication_manager/rest/config/asterisk/{coreServerId}/extensionsGroups/{extensionGroupId}/editors/{userId}
Description

Accesses the configuration of a specific editor in the extension group.

Parameters:

  • userId: The configuration id of the user.
GET

Gets the configuration of the specified editor in the extension group.

Errors:

  • 404 'A editor with the given id does not exist': Returned if no editor exists in the extension group with the given id.
DELETE

Removes a specific editor from the extension group.

Errors:

  • 404 'A editor with the given id does not exist': Returned if no editor exists in the extension group with the given id.

Curl Examples

Get all editors in an extension group

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroup/56cf70a3-1ee0-4b09-8f40-297430eeeddf/editors

Get the configuration for a specific editor in an extension group

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroup/56cf70a3-1ee0-4b09-8f40-297430eeeddf/editors/e05a9e3c-c306-4bba-abd7-4fe1034fe9f6

Add a editor to an extension group

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d {"id":"56cf70a3-1ee0-4b09-8f40-297430eeeddf","username":"4224","password":"mypassword","enabled":true,"full":true,"displayName":"Steve S","lastPasswordChangedAt":null,"permissionDisplayName":"Steve S","permissionId":"56cf70a3-1ee0-4b09-8f40-297430eeeddf"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroup/56cf70a3-1ee0-4b09-8f40-297430eeeddf/editors

Remove a editor from an extension group

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroup/56cf70a3-1ee0-4b09-8f40-297430eeeddf/editors/e05a9e3c-c306-4bba-abd7-4fe1034fe9f6

 

viewers
  • No labels