Get

Single custom permission set

Returns a single permission set defined in the workspace. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/permissions/:permission_set_id

URL Parameters

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

Example

Request

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

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

type can be either DEVELOPER, READ_ONLY or CUSTOM.

Learn more about GET commands: - Groups - Pull requests - Tags

Permission sets in a workspace

Returns all permission sets defined in the workspace. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/permissions

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.

Example

Request

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

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",
  "html_url": "https://app.buddy.works/buddy/permissions",
  "permission_sets": [
    {
      "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"
    },
    {
      "url": "https://api.buddy.works/workspaces/buddy/permissions/3",
      "html_url": "https://app.buddy.works/buddy/permissions/edit/3",
      "id": 3,
      "name": "Artist",
      "description": null,
      "type": "CUSTOM",
      "repository_access_level": "READ_ONLY",
      "pipeline_access_level": "DENIED",
      "sandbox_access_level": "DENIED"
    },
    {
      "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",
      "sandbox_access_level": "READ_WRITE"
    }
  ]
}

Get Started

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