Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

Info

The information on this page applies to iSymphony 3.1+.

Description

The user group REST resource allows access to the configuration for user groups in the system. This resource allows adding, removing, and updating of user groups in the system. User groups are used by the permission system. See Permissions Configuration.

 

Panel
titleOn this page:

Table of Contents
maxLevel2
indent1
 

Root Resource Path

Code Block
communication_manager/rest/config/core/{coreServerId}/userGroups

JSON Representation

Code Block
{
    "id": "b6078433-d2e8-4d92-924a-80e7ed386164",
    "displayName": "Managers",
    "permissionDisplayName": "Managers",
    "permissionId": "b6078433-d2e8-4d92-924a-80e7ed386164"
}
PropertyTypeDescription
id
String

Configuration id of the user group.

displayNameStringDisplay name of the user group.
permissionDisplayNameStringDisplay name of the user group in teh permission system.
permissionIdStringThe permission id of the user group.

Resource Paths

communication_manager/rest/config/core/{coreServerId}/userGroups
DescriptionAccesses all the user groups in the core server.
GET Gets all the user groups in the core server.
POST

Adds a user group to the configuration.

Errors:

  • 409 'A user group with the given id already exists.': Returned if a user group with the given id already exists.
  • 409 'A user group with the given name already exists.': Returned if a user group with the given name already exists.
  • 412 'No displayName provided.': Returned if no display name was provided.
 
communication_manager/rest/config/core/{coreServerId}/userGroups/{userGroupId}
Description

Accesses the configuration of a specific user group.

Parameters:

  • userGroupId: The configuration id of the user group.
GET

Gets the configuration of the specified user group.

Errors:

  • 404 'A user group with the given id does not exist': Returned if no user group exists with the given id.
PUT

Updates the specified user group configuration.

Errors:

  • 404 'A user group with the given id does not exist': Returned if no user group exists with the given id.
  • 409 'A user group with the given name already exists.': Returned if a user group with the given name already exists.
  • 412 'No display name provided.': Returned if no display name was provided.
DELETE

Deletes the specified user group configuration.

Errors:

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

Sub/Child Resource Paths

communication_manager/rest/config/core/{coreServerId}/userGroups/{userGroupId}/users
Description

Access the sub/child resource for the users that are part of the user group.

Parameters:

  • userGroupId: The configuration id of the user group.

Errors:

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

See Group Users Configuration for more information.

Curl Examples

Get all user Groups in a core server

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/userGroups

Get the configuration for a specific user group

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

Add a new User Group

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id":"b6078433-d2e8-4d92-924a-80e7ed386164","displayName":"Managers","permissionDisplayName":"Managers","permissionId":"b6078433-d2e8-4d92-924a-80e7ed386164"}' http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/users

Delete an user group

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

Update a user group

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"56cf70a3-1ee0-4b09-8f40-297430eeeddf","displayName":"Managers New","permissionDisplayName":"Managers New","permissionId":"b6078433-d2e8-4d92-924a-80e7ed386164"}' http://localhost:58080/communication_manager/rest/config/core/ee828da8-5ee6-412d-82ac-1273f598659d/users/56cf70a3-1ee0-4b09-8f40-297430eeeddf