Wiki source code of Asterisk Extension Group Editors
Last modified by ryanp on 2021/09/10 23:34
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{layout}} | ||
2 | {{layout-section ac:type="two_right_sidebar"}} | ||
3 | {{layout-cell}} | ||
4 | {{warning}} | ||
5 | This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors. | ||
6 | {{/warning}} | ||
7 | |||
8 | {{info}} | ||
9 | The information on this page applies to **iSymphony 3.1+**. | ||
10 | {{/info}} | ||
11 | |||
12 | = (% style="color: rgb(0,0,0);" %)Description(%%) = | ||
13 | |||
14 | 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. | ||
15 | |||
16 | |||
17 | {{/layout-cell}} | ||
18 | |||
19 | {{layout-cell}} | ||
20 | {{panel title="On this page:"}} | ||
21 | |||
22 | |||
23 | {{toc maxLevel="2" indent="1"/}} | ||
24 | {{/panel}} | ||
25 | {{/layout-cell}} | ||
26 | {{/layout-section}} | ||
27 | |||
28 | {{layout-section ac:type="single"}} | ||
29 | {{layout-cell}} | ||
30 | = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) = | ||
31 | |||
32 | {{code}} | ||
33 | communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/editors | ||
34 | {{/code}} | ||
35 | |||
36 | = JSON Representation = | ||
37 | |||
38 | {{code}} | ||
39 | { | ||
40 | "id": "56cf70a3-1ee0-4b09-8f40-297430eeeddf", | ||
41 | "username": "4224", | ||
42 | "password": "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4", | ||
43 | "enabled": true, | ||
44 | "full": true, | ||
45 | "displayName": "Steve S", | ||
46 | "lastPasswordChangedAt": null, | ||
47 | "permissionDisplayName": "Steve S", | ||
48 | "permissionId": "56cf70a3-1ee0-4b09-8f40-297430eeeddf" | ||
49 | } | ||
50 | {{/code}} | ||
51 | |||
52 | |=((( | ||
53 | Property | ||
54 | )))|=((( | ||
55 | Type | ||
56 | )))|=((( | ||
57 | Description | ||
58 | ))) | ||
59 | |((( | ||
60 | {{{id}}} | ||
61 | )))|((( | ||
62 | String | ||
63 | )))|((( | ||
64 | Configuration id of the user. | ||
65 | ))) | ||
66 | |(% colspan="1" %)(% colspan="1" %) | ||
67 | ((( | ||
68 | username | ||
69 | )))|(% colspan="1" %)(% colspan="1" %) | ||
70 | ((( | ||
71 | String | ||
72 | )))|(% colspan="1" %)(% colspan="1" %) | ||
73 | ((( | ||
74 | Username of the user. | ||
75 | ))) | ||
76 | |(% colspan="1" %)(% colspan="1" %) | ||
77 | ((( | ||
78 | password | ||
79 | )))|(% colspan="1" %)(% colspan="1" %) | ||
80 | ((( | ||
81 | String | ||
82 | )))|(% colspan="1" %)(% colspan="1" %) | ||
83 | ((( | ||
84 | SHA-1 hash of the user's password. | ||
85 | ))) | ||
86 | |(% colspan="1" %)(% colspan="1" %) | ||
87 | ((( | ||
88 | enabled | ||
89 | )))|(% colspan="1" %)(% colspan="1" %) | ||
90 | ((( | ||
91 | Boolean | ||
92 | )))|(% colspan="1" %)(% colspan="1" %) | ||
93 | ((( | ||
94 | Flag specifying if the user is enabled. | ||
95 | ))) | ||
96 | |(% colspan="1" %)(% colspan="1" %) | ||
97 | ((( | ||
98 | full | ||
99 | )))|(% colspan="1" %)(% colspan="1" %) | ||
100 | ((( | ||
101 | Boolean | ||
102 | )))|(% colspan="1" %)(% colspan="1" %) | ||
103 | ((( | ||
104 | Flag specifying if the user is a full or lite user. | ||
105 | ))) | ||
106 | |(% colspan="1" %)(% colspan="1" %) | ||
107 | ((( | ||
108 | displayName | ||
109 | )))|(% colspan="1" %)(% colspan="1" %) | ||
110 | ((( | ||
111 | String | ||
112 | )))|(% colspan="1" %)(% colspan="1" %) | ||
113 | ((( | ||
114 | The display name for the user. | ||
115 | ))) | ||
116 | |(% colspan="1" %)(% colspan="1" %) | ||
117 | ((( | ||
118 | {{{lastPasswordChangedAt}}} | ||
119 | )))|(% colspan="1" %)(% colspan="1" %) | ||
120 | ((( | ||
121 | Long | ||
122 | )))|(% colspan="1" %)(% colspan="1" %) | ||
123 | ((( | ||
124 | The last time the user changed their password from the client interface. Represented as a Unix timestamp in milliseconds. Can be null. | ||
125 | ))) | ||
126 | |(% colspan="1" %)(% colspan="1" %) | ||
127 | ((( | ||
128 | {{{permissionDisplayName}}} | ||
129 | )))|(% colspan="1" %)(% colspan="1" %) | ||
130 | ((( | ||
131 | String | ||
132 | )))|(% colspan="1" %)(% colspan="1" %) | ||
133 | ((( | ||
134 | Display name of the user in the permission system. | ||
135 | ))) | ||
136 | |(% colspan="1" %)(% colspan="1" %) | ||
137 | ((( | ||
138 | {{{permissionId}}} | ||
139 | )))|(% colspan="1" %)(% colspan="1" %) | ||
140 | ((( | ||
141 | String | ||
142 | )))|(% colspan="1" %)(% colspan="1" %) | ||
143 | ((( | ||
144 | Permission id of the user. | ||
145 | ))) | ||
146 | |||
147 | = (% style="line-height: 1.25;" %)Resource Paths(%%) = | ||
148 | |||
149 | |=(% colspan="2" %)(% colspan="2" %) | ||
150 | ((( | ||
151 | {{{communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}/editors}}} | ||
152 | ))) | ||
153 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
154 | ((( | ||
155 | **Description** | ||
156 | )))|((( | ||
157 | Accesses all the users that are marked as editors of the group. | ||
158 | ))) | ||
159 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
160 | ((( | ||
161 | **GET** | ||
162 | )))|((( | ||
163 | Gets all the configuration for all the users that are makred as editors of the group. | ||
164 | ))) | ||
165 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
166 | ((( | ||
167 | **POST | ||
168 | ** | ||
169 | )))|(% colspan="1" %)(% colspan="1" %) | ||
170 | ((( | ||
171 | Adds a user as a editor of the extension group. | ||
172 | |||
173 | (% style="line-height: 1.42857;" %)**Errors:** | ||
174 | |||
175 | * 409 'The specified editor already exists in the extension group.': Returned if the user is already a editor in the extension group. | ||
176 | ))) | ||
177 | |(% colspan="2" %)(% colspan="2" %) | ||
178 | ((( | ||
179 | |||
180 | ))) | ||
181 | |=(% colspan="2" %)(% colspan="2" %) | ||
182 | ((( | ||
183 | {{{communication_manager/rest/config/asterisk/{coreServerId}/extensionsGroups/{extensionGroupId}/editors/{userId}}}} | ||
184 | ))) | ||
185 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
186 | ((( | ||
187 | **Description** | ||
188 | )))|((( | ||
189 | Accesses the configuration of a specific editor in the extension group. | ||
190 | |||
191 | **Parameters:** | ||
192 | |||
193 | * userId: The configuration id of the user. | ||
194 | ))) | ||
195 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
196 | ((( | ||
197 | **GET** | ||
198 | )))|((( | ||
199 | Gets the configuration of the specified editor in the extension group. | ||
200 | |||
201 | **Errors:** | ||
202 | |||
203 | * 404 'A editor with the given id does not exist': Returned if no editor exists in the extension group with the given id. | ||
204 | ))) | ||
205 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
206 | ((( | ||
207 | **DELETE** | ||
208 | )))|(% colspan="1" %)(% colspan="1" %) | ||
209 | ((( | ||
210 | Removes a specific editor from the extension group. | ||
211 | |||
212 | **Errors:** | ||
213 | |||
214 | * 404 'A editor with the given id does not exist': Returned if no editor exists in the extension group with the given id. | ||
215 | ))) | ||
216 | |||
217 | = Curl Examples = | ||
218 | |||
219 | === Get all editors in an extension group === | ||
220 | |||
221 | {{code language="bash"}} | ||
222 | 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 | ||
223 | {{/code}} | ||
224 | |||
225 | === Get the configuration for a specific editor in an extension group === | ||
226 | |||
227 | {{code language="bash"}} | ||
228 | 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 | ||
229 | {{/code}} | ||
230 | |||
231 | === Add a editor to an extension group === | ||
232 | |||
233 | {{code language="bash"}} | ||
234 | 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 | ||
235 | {{/code}} | ||
236 | |||
237 | === Remove a editor from an extension group === | ||
238 | |||
239 | {{code language="bash"}} | ||
240 | 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 | ||
241 | {{/code}} | ||
242 | |||
243 | |||
244 | |||
245 | {{{viewers}}} | ||
246 | {{/layout-cell}} | ||
247 | {{/layout-section}} | ||
248 | {{/layout}} |