Usergroup Resource
Version: 3.3
Each usergroup in the system is represented by a Usergroup Resource. This resource can be used to retrieve the state of the usergroup.
The following methods are supported: GET, HEAD
GET /api/usergroups/id
Returns an Usergroup Object that contains the state of the usergroup.
Example Request:
RequestResponse
GET http://hostname/api/usergroups/2
Host: hostname
Accept: application/json
Example Response:
RequestResponse
HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"
{
"id": 2,
"properties": {
"GroupName": "Everyone"
},
"relations": {
"UserGroupToUser": {
"href": "http://m.local/api/entities/2/relations/UserGroupToUser"
}
},
"created_by": {
"href": "http://m.local/api/users/0",
"title": "The user who created the entity"
},
"created_on": "2014-03-23T13:47:29.8058106Z",
"modified_by": {
"href": "http://m.local/api/users/0",
"title": "The user who last modified the entity"
},
"modified_on": "2014-03-23T13:47:29.8058106Z",
"entitydefinition": {
"href": "http://m.local/api/entitydefinitions/UserGroup",
"title": "The entity definition for this entity"
},
"copy": {
"href": "http://m.local/api/usergroups/2/copy",
"title": "Copy this entity"
},
"permissions": {
"href": "http://m.local/api/usergroups/2/permissions",
"title": "The permissions on this entity"
},
"lifecycle": {
"href": "http://m.local/api/usergroups/2/lifecycle",
"title": "The lifecycle action for this entity."
},
"policy": {
"href": "http://m.local/api/usergroups/2/policy",
"title": "The policy that applies to this user group."
},
"self": {
"href": "http://m.local/api/usergroups/2",
"title": "This entity"
}
}