Update

Member permission set

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

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/projects/:project_name/members/:member_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
member_id
Required
IntegerThe numerical ID of the desired user.
project_name
Required
StringThe name of the project.

POST Parameters

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

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/projects/company-website/members/1

JSON

{
  "permission_set": {
    "id": "1"
  }
}

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/member/1",
  "html_url": "https://app.buddy.works/buddy/company-website/members/profile/1",
  "id": 1,
  "name": "Mike Benson",
  "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
  "admin": true,
  "workspace_owner": true,
  "permission_set": {
    "url": "https://api.buddy.works/workspaces/buddy/permissions/1",
    "html_url": "https://app.buddy.works/buddy/permissions/edit/1",
    "id": 1,
    "name": "Developer",
    "description": null,
    "type": "DEVELOPER",
    "repository_access_level": "READ_WRITE",
    "pipeline_access_level": "READ_WRITE"
  }
}

User group permission set

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

Last modified on April 26, 2022

Get Started

Sign up for free and deploy your project in less than 10 minutes.