Add a group

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /groups

Adds a group of users to the project. Restricted to administrators.

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
domainrequired string
The workspace domain.
project_namerequired string
The name of the project.
POST PARAMETERS
idrequired integer
The numerical ID of the desired user.
permission_setrequired permission_set
Specifies the permissions assigned to the user in the project.

Last modified on Sep 27, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/groups/" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "id": 2,
  "permission_set": {
    "id": 2
  }
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/2/group/2", "html_url": "https://app.buddy.works/buddy/company-website/team", "id": 2, "name": "Developers", "permission_set": { "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999