Edit

Edits a custom permission set. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

PATCH /workspaces/:domain/permissions/:permission_set_id

URL Parameters

Name	Type	Description
domain `Required`	String	The workspace domain.
permission_set_id `Required`	Integer	The numerical ID of the desired permission set.

POST Parameters

Name	Type	Description
description	String	The description of the permission set.
name `Required`	String	The name of the permission set.
pipeline_access_level `Required`	String	Can be one of `DENIED`, `READ_ONLY`, `RUN_ONLY`, or `READ_WRITE`.
repository_access_level `Required`	String	Can be one of `READ_ONLY`, `READ_WRITE`, or `MANAGE`.
sandbox_access_level `Required`	String	Can be one of `DENIED`, `READ_ONLY`, or `READ_WRITE`.
project_team_access_level	String	Can be `READ_ONLY`or `MANAGE`.

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_ONLY",
  "pipeline_access_level": "DENIED",
  "sandbox_access_level": "DENIED",
  "project_team_access_level": "READ_ONLY"
}

Last modified on November 8, 2022

Edit

Knowledge is power!