Участники компонента "Project board"

Используйте REST API для управления участниками совместной работы в project board.

List project collaborators

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`project_id`integerRequired The unique identifier of the project.
Query parameters
Имя, Type, Описание
`affiliation`string Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. Default: `all` Can be one of: `outside`, `direct`, `all`
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Описание
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples

get/projects/{project_id}/collaborators

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Add project collaborator

Works with GitHub Apps

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.
Body parameters
Имя, Type, Описание
`permission`string The permission to grant the collaborator. Default: `write` Can be one of: `read`, `write`, `admin`

HTTP response status codes

Status code	Описание
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples

put/projects/{project_id}/collaborators/{username}

curl \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME \
  -d '{"permission":"write"}'

Response

Status: 204

Remove user as a collaborator

Works with GitHub Apps

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.

HTTP response status codes

Status code	Описание
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples

delete/projects/{project_id}/collaborators/{username}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME

Response

Status: 204

Get project permission for a user

Works with GitHub Apps

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

Parameters

Headers
Имя, Type, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Имя, Type, Описание
`project_id`integerRequired The unique identifier of the project.
`username`stringRequired The handle for the GitHub user account.

HTTP response status codes

Status code	Описание
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Code samples

get/projects/{project_id}/collaborators/{username}/permission

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/projects/PROJECT_ID/collaborators/USERNAME/permission

Response

Status: 200

{
  "permission": "admin",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
}