Create

Creates a custom permission set. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

POST /workspaces/:domain/permissions

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.

POST Parameters

NameTypeDescription
descriptionStringThe 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 READ_ONLY, READ_WRITE, or MANAGE.
sandbox_access_level
Required
StringCan be one of DENIED, READ_ONLY, or READ_WRITE.
project_team_access_levelStringCan be READ_ONLYor MANAGE.

Example

Request

POST https://api.buddy.works/workspaces/buddy/permissions

JSON

{
  "name": "Artist",
  "description": "Artists can only view source",
  "repository_access_level": "READ_ONLY",
  "pipeline_access_level": "DENIED",
  "sandbox_access_level": "DENIED"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/permissions/4",
  "html_url": "https://app.buddy.works/buddy/permissions/edit/4",
  "id": 4,
  "name": "Artist",
  "description": "Artists can access 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

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

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