Add
Add a member
Adds a user to the project. Restricted to administrators.
Required scopes: WORKSPACE
Resource URL
POST /workspaces/:domain/projects/:project_name/members
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
project_name Required | String | The name of the project. |
POST Parameters
Name | Type | Description |
---|---|---|
id Required | Integer | The numerical ID of the desired user. |
permission_set Required | permission_set | Specifies the permissions assigned to the user in the project. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/members
JSON
{
"id": 2,
"permission_set": {
"id": 2
}
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/2/member/2",
"html_url": "https://app.buddy.works/buddy/company-website/members/profile/2",
"id": 2,
"name": "Sylvia Jones",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/2/71f5a2ec2e1f4af1cf357e631cd2518e/w/32/32/AVATAR.png",
"admin": false,
"workspace_owner": false,
"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"
}
}
Add a group
Adds a group of users to the project. Restricted to administrators.
Required scopes: WORKSPACE
Resource URL
POST /workspaces/:domain/projects/:project_name/groups/
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
project_name Required | String | The name of the project. |
POST Parameters
Name | Type | Description |
---|---|---|
id Required | Integer | The numerical ID of the user group. |
permission_set Required | permission_set | Specifies the permissions assigned to the group in the project. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/groups
JSON
{
"id": 2,
"permission_set": {
"id": 2
}
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"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"
}
}
Last modified on April 26, 2022