Edit

  • PATCH
  • /workspaces
  • /:domain
  • /permissions
  • /:permission_set_id

Edits a custom permission set. Restricted to admins only.

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
domainrequired string
The workspace domain.
permission_set_idrequired integer
The numerical ID of the desired permission set.
POST PARAMETERS
descriptionoptional string
The description of the permission set.
namerequired string
The name of the permission set.
pipeline_access_levelrequired string
Can be one of DENIED, READ_ONLY, RUN_ONLY, or READ_WRITE.
repository_access_levelrequired string
Can be one of READ_ONLY, READ_WRITE, or MANAGE.
sandbox_access_levelrequired string
Can be one of DENIED, READ_ONLY, or READ_WRITE.
project_team_access_leveloptional string
Can be READ_ONLYor MANAGE.

Last modified on Sep 23, 2024

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:domain/permissions/:permission_set_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Artists can only view source",
  "pipeline_access_level": "DENIED"
}'
EXAMPLE RESPONSE
{ "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" }
STATUS
200 OK
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999