Edit

Updates a custom permission set. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/permissions/:permission_set_id

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
permission_set_id
Required
IntegerThe numerical ID of the desired permission set.

POST Parameters

NameTypeDescription
description
Required
StringThe description of the permission set.
name
Required
StringThe name of the permission set.
pipeline_access_level
Required
StringCan be one of DENIED, READ_ONLY, RUN_ONLY or READ_WRITE.
repository_access_level
Required
StringCan be one of DENIED, READ_ONLY or READ_WRITE.

Example

Request

PATCH https://api.buddy.works/workspaces/buddy/permissions/3

JSON

{
  "description": "Artists can only view source",
  "pipeline_access_level": "DENIED"
}

Sample Response

HTTP

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

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/permissions/3",
  "html_url": "https://app.buddy.works/buddy/permissions/edit/3",
  "id": 3,
  "name": "Artist",
  "description": "Artists can only view source",
  "type": "CUSTOM",
  "repository_access_level": "READ_WRITE",
  "pipeline_access_level": "DENIED"
}
Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.