Child pages
  • User Groups
Skip to end of metadata
Go to start of metadata

View or modify user groups

Resource URI: /user-group
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Unique identification number of the user group.

name

Name of the user group.

Filtering Parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all the user groups.
Example: XML format

https://\[server\]/sipxconfig/rest/user-group?sortdir=forward&sortby=description&page=1&pagesize=1


<user-group>
<metadata>
<totalResults>7</totalResults>
<currentPage>1</currentPage>
<totalPages>7</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<groups>
<group>
<id>19</id>
<name>ldap_imports</name>
</group>
</groups>
</user-group>
JSON format
{"usergroup": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"groups": [


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IMGroup"
}
]
}}
HTTP Method: PUT
Adds a new user group. The "id" is auto-generated and any value is ignored. The "branch" element is optional.
<userGroup>
<id>5</id>
<name>JusticeLeague</name>
<description>Superheroes Unlimited</description>
<branch>
<id>1</id>
<name>HallOfJustice</name>
<description>Hall of Superheroes</description>
<address>
<id>3</id>
<street>1 Justice Way</street>
<city>Smallville</city>
<country>United States</country>
<state>MidAmerica</state>
<zip>55555</zip>
<officeDesignation>MailStop</officeDesignation>
</address>
<phoneNumber>555-HERO</phoneNumber>
</branch>
</userGroup>
Unsupported HTTP Method: POST, DELETE


View or modify a user group ID

Resource URI: /user-group/{id}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

totalResults

Number of total results.

currentPage

Number of the current page.

totalPages

Number of total pages.

resultsPerPage

Number of results per page.

group

Heading with details on the user group.

id

Group ID.

name

Group name.

description

Short description of the group

Specific Response Codes: Error 400 - when {id} is invalid or not found
HTTP Method: GET
Retrieves information on the user group with the specified ID.
Example: XML format
<user-group>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
<groups>
<group>
<id>5</id>
<name>administrators</name>
<description>Users with superadmin privileges</description>
</group>
<group>
<id>9</id>
<name>IM-Group</name>
</group>
</groups>
</user-group>
JSON format
{"user-group": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"groups": [


{
"id": 5,
"name": "administrators",
"description": "Users with superadmin privileges"
},
{
"id": 9,
"name": "IM-Group"
}
]
}}
HTTP Method: PUT
Updates group with the specified ID. Uses the same XML as for creation.
HTTP Method: DELETE
Removes branch with the specified ID.
Unsupported HTTP Method: POST


View or modify user group permissions

Resource URI: /user-group-permission
Default Resource Properties: N/A
Filtering parameters:

Parameter

Description

page

Required. The requested page size

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse

sortby

Optional. Name/description

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all user groups and their permission settings.
Unsupported HTTP Method: POST, PUT, DELETE

View or modify permissions for a group ID

Resource URI: /user-group-permission/{id}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Group unique identification number.

name

Group name.

description

Short description provided by the user.

name

Permission name.

value

Displays True if it is enabled or False if it is disabled.

defaultValue

Default value.

Filtering parameters:

Parameter

Description

page

Required. The requested page size.

pagesize

Required. The number of results to be displayed per page.

sortdir

Optional. Forward/reverse.

sortby

Optional. Name/description.

Specific Response Codes: Error 400 - when {id} is invalid or not found.
HTTP Method: GET
Retrieves information on user group with the specified ID and its permissions.
Example: XML format
<group>
<id>5</id>
<name>JusticeLeague</name>
<description>Superheroes of America</description>
<permissions>
<setting>
<name>900Dialing</name>
<value>ENABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>AutoAttendant</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>ExchangeUMVoicemailServer</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>FreeswitchVoicemailServer</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>InternationalDialing</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LocalDialing</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LongDistanceDialing</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Mobile</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>RecordSystemPrompts</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>TollFree</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Voicemail</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>music-on-hold</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>perm_3</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_4</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_7</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>personal-auto-attendant</name>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>subscribe-to-presence</name>
<value>DISABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>superadmin</name>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>tui-change-pin</name>
<defaultValue>true</defaultValue>
</setting>
</permissions>
</group>
HTTP Method: PUT
Sets permission values for a user group. Notes:

  • The ID is auto-generated and any value will be ignored
  • The Setting element must contain a value element.
  • The Value must be set to either Enable or Disable. The Value element is blank if the permission is set to the default and has never been changed.
  • The defaultValue is for information only and is read-only.
  • Not all permissions need to be updated at once. They can be listed individually or in subgroups.

Unsupported HTTP Method: POST, DELETE

  • No labels