groups

List groups

Lists all user groups. The group IDs and names are included in the response.

Request

get
/groups

Response

{
  "status": "200"
}

Create a group

Creates a new group with the given name.

The group_id parameter is deprecated and will no longer be accepted in a future major release. For now, group_id will be used as name if it is provided.

Parameters

Name Type Required Description
name string true a name for the group

Errors

StatusDescription
400 Group already exists

Request

post
/groups
{
  "name": "Research"
}

Response

{
  "example": {
    "id": "research",
    "name": "research",
    "permissions": {
      "cancel_job": true,
      "create_ref": false,
      "create_sample": true,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": true,
      "upload_file": true
    },
    "users": []
  },
  "status": "201"
}

Delete a group

Deletes a group by its 'group id'.

Request

delete
/groups/{group_id}

Get a group

Fetches the complete representation of a single user group including its permissions.

Errors

StatusDescription
404 Group not found

Request

get
/groups/{group_id}

Response

{
  "example": {
    "id": "research",
    "name": "research",
    "permissions": {
      "cancel_job": true,
      "create_ref": false,
      "create_sample": true,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": true,
      "upload_file": true
    },
    "users": []
  },
  "status": "200"
}

Update a group

Updates a group's name or permissions.

Permissions that are not included in the permissions object will retain their previous setting.

Parameters

Name Type Required Description
name string false a name for the group
permissions false a permission update comprising an object keyed by permissions with boolean values

Errors

StatusDescription
404 Group not found

Request

patch
/groups/{group_id}
{
  "name": "Managers",
  "permissions": {
    "create_ref": true
  }
}

Response

{
  "example": {
    "id": "research",
    "name": "research",
    "permissions": {
      "cancel_job": true,
      "create_ref": false,
      "create_sample": true,
      "modify_hmm": false,
      "modify_subtraction": false,
      "remove_file": false,
      "remove_job": true,
      "upload_file": true
    },
    "users": []
  },
  "status": "200"
}