Summary:
List and modify the set of tools accessible to a user group.
URL:
http(s)://{server hostname}/api/userGroups/{groupID}/tools
Methods summary
- GET Method - lists tools that this user group has permission to access.
- PUT Method - modifies the list of tools that this user group has permission to access.
GET Method detail
The list of tools that this group has a permission to access.
Response:
List of items, each one according to the following format:
Name | Description |
---|---|
id | tool ID. |
name | tool name. |
subgroup | name of the subgroup that given tool is part of. |
Examples:
INPUT
curl -u admin:admin https://localhost/api/userGroups/6/tools?media=json
OUTPUT
{
"items": [],
"count": 0
}
INPUT
curl -u admin:admin https://localhost/api/userGroups/6/tools?media=xml
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="0"/>
PUT Method detail
Modifies the list of tools to which the user group has permission to access.
Request:
The list of tool IDs.
Response:
The updated list of group permissions, as 'GET Method' above would return them.
Examples:
INPUT
curl -u admin:admin https://localhost/api/userGroups/6/tools?media=json X PUT -H "content-type:application/json" -d \
'{
"tools" : [ {
"id" : 15
}, {
"id" : 89
} ]
}'
OUTPUT
{
"items" : [ {
"id" : 15,
"toolName" : "Ticker",
"groupName" : "Tools"
}, {
"id" : 89,
"toolName" : "Data Export",
"groupName" : "Administrator Tools"
} ],
"count" : 2
}
INPUT
curl -u admin:admin https://localhost/api/userGroups/6?media=xml -X PUT -H "content-type:application/xml" -d \
'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<groupToolsWrapper>
<tool id="15" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
<tool id="89" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
</groupToolsWrapper>'
OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
<item xsi:type="toolId" groupName="Tools" id="15" toolName="Ticker" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
<item xsi:type="toolId" groupName="Administrator Tools" id="89" toolName="Data Export" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
</items>
Comments
0 comments
Please sign in to leave a comment.