REST APIs

Usergroup

A Usergroup Object contains the state of a user group. It inherits all members from the Entity Object, and adds the following properties:

Name	Type	Description
`policy`	Link	A link to the Policy Resource that is applicable to this user group.

Example

{
  "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"
  }
}

If you have suggestions for improving this article, let us know!