Asterisk Extension Managing User

Version 5.1 by michaely on 2016/05/31 13:40

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 extension managing user REST resource allows access to the managing user (user that owns the extension) of a specific extension. This resource allows you to set and unset the user that manages the extension.

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/core/{coreServerId}/extensions/{extensionId}/managingUser

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/core/{coreServerId}/extensions/{extensionId}/managingUser
Description	Accesses the managing user of the extension.
GET	Gets the managing user for the extension. Errors: 404 'Extension has not set user': The extension does not have a managing user set.
POST	Sets the provided user as the managing user for the extension. Errors: 409 'The Extension's managed user is already set to the given user.': Returned if the provided user is already the managing user for the extension. 409 'A user with the given username already exists.': Returned if a user 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	Un-sets any currently set managing user on the extension.

Curl Examples

Gets the managing user for an extension

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

Set a managing user for an extension

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id":"ed38fe4d-13ad-4fd0-be25-d3404c421370","username":"4224","password":"60b6e3843f2b26d3a24c27c4f3f071861c2f14e4","enabled":true,"full":false,"displayName":"Michael Y (desk)","lastPasswordChangedAt":null,"permissionDisplayName":"Michael Y (desk)","permissionId":"ed38fe4d-13ad-4fd0-be25-d3404c421370"}' http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/extension/56cf70a3-1ee0-4b09-8f40-297430eeeddf/managingUser

Clear the managing user on the extension

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/extensions/56cf70a3-1ee0-4b09-8f40-297430eeeddf/managingUser