Master
Versions: Euwe / Fine / Latest /

Group Management

Management of User Groups is provided via the following collection:

/api/groups

Full CRUD actions on groups is available:

Querying Groups

Querying all groups in the system:

GET /api/groups

Getting details on a specific group:

GET /api/groups/:id

Creating Groups

Groups can be created via a POST to the groups collection or via the create action signature which also allows creation of multiple groups in a single request.

POST /api/groups
{
  "description" : "sample_group",
  "role" : { "id" : 2 },
  "tenant" : { "href" : "http://localhost:3000/api/tenants/1" },
  "filters" : {
    "belongsto" : [ "/managed/area/1", "/managed/area/2" ],
    "managed" : [[ "/managed/infra/1", "/managed/infra/2" ]]
  }
}

role can be specified via name, href, or id

tenant can be specified via href or id

or creating multiple groups:

{
  "action" : "create",
  "resources" : [
    { "description" : "sample_group1", ... },
    { "description" : "sample_group2", ... },
    ...
  ]
}

Please refer to the Resource Attributes page for a list of available attributes when creating Groups.

Editing Groups

POST /api/groups/:id
{
  "action" : "edit",
  "resource" : {
    "description" : "updated_sample_group",
    "filters" : {
      "belongsto" : [ "/managed/area/1", "/managed/area/2", "/managed/area/3" ],
      "managed" : [[ "/managed/infra/1", "/managed/infra/2"], ["/managed/other/3"]]
    }
  }
}

or editing multiple groups:

POST /api/groups
{
  "action" : "edit",
  "resources" : [
    {
      "href" : "http://localhost:3000/api/groups/101",
      "description" : "updated_sample_group1"
    },
    {
      "href" : "http://localhost:3000/api/groups/102",
      "description" : "updated_sample_group2"
    },
    ...
  ]
}

Deleting Groups

groups can be deleted via either the delete POST action or via the DELETE HTTP method.

POST /api/groups/101
{
  "action" : "delete"
}

or simply:

DELETE /api/groups/101

Deleting multiple groups can be done as follows:

POST /api/groups
{
  "action" : "delete",
  "resources" : [
    { "href" : "http://localhost:3000/api/groups/101" },
    { "href" : "http://localhost:3000/api/groups/102" },
    ...
  ]
}