Update user group permissions

Changes permission set of the selected user group in the project. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/projects/:project_name/groups/:group_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
group_id
Required
IntegerThe numerical ID of the user group.
project_name
Required
StringThe name of the project.

POST Parameters

NameTypeDescription
permission_set
Required
permission_setDefines the permission set with which the user group is added to the project.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/projects/company-website/groups/2

JSON

{
  "permission_set": {
    "id": "2"
  }
}

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/2/group/2",
  "html_url": "https://app.buddy.works/buddy/company-website/team",
  "id": 2,
  "name": "Developers",
  "permission_set": {
    "url": "https://api.buddy.works/workspaces/buddy/permissions/2",
    "html_url": "https://app.buddy.works/buddy/permissions/edit/2",
    "id": 2,
    "name": "Read-only",
    "description": null,
    "type": "READ_ONLY",
    "repository_access_level": "READ_ONLY",
    "pipeline_access_level": "READ_ONLY",
    "sandbox_access_level": "READ_ONLY"
  }
}