Asterisk Extension Group Users

Last modified by ryanp 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.1+.

Description

The Asterisk extension group users REST resource allows access to the users that are a part of an extension group. This resource allows adding and removing of users to and from an extension group.

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/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/users

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"
}

Property	Type	Description
id	String	Configuration id of the user.
username	String	Username of the user.
password	String	SHA-1 hash of the user's password.
enabled	Boolean	Flag specifying if the user is enabled.
full	Boolean	Flag specifying if the user is a full or lite user.
displayName	String	The display name for the user.
lastPasswordChangedAt	Long	The last time the user changed their password from the client interface. Represented as a Unix timestamp in milliseconds. Can be null.
permissionDisplayName	String	Display name of the user in the permission system.
permissionId	String	Permission id of the user.

Resource Paths

communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/users
Description	Accesses all the users that are part of the extension group.
GET	Gets all the configuration for all the users that are part of the extension group.
POST	Adds a user to the extension group. Errors: 409 'The specified users already exists in the extension group.': Returned if the users is already a part of the extension group.

communication_manager/rest/config/asterisk/{coreServerId}/extensionsGroups/{extensionGroupId}/users/{userId}
Description	Accesses the configuration of a specific users in the extension group. Parameters: userId: The configuration id of the user.
GET	Gets the configuration of the specified user in the extension group. Errors: 404 'A user with the given id does not exist': Returned if no users exists in the extension group with the given id.
DELETE	Removes a specific user from the extension group. Errors: 404 'A user with the given id does not exist': Returned if no user exists in the extension group with the given id.

Curl Examples

Get all users 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/users

Get the configuration for a specific user in an extension group

Add a user 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/users

Remove a user 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/users/e05a9e3c-c306-4bba-abd7-4fe1034fe9f6