이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

Project (classic) 협력자에 대한 REST API 엔드포인트

참고 항목

Projects (classic)이 사용 중지되었습니다. 이 변경에 대한 자세한 내용은 the Blog에서 확인할 수 있습니다.

새롭고 향상된 프로젝트 환경이 제공됩니다. 자세한 내용은 Projects 정보을(를) 참조하세요.

이러한 엔드포인트는 projects (classic)와(과)만 상호 작용합니다. GraphQL API를 사용하여 Projects 관리 자세한 내용은 API를 사용하여 Projects 관리을(를) 참조하세요.

참고 항목

projects (classic)을(를) 관리하는 REST API는 personal access token (classic)을(를) 사용하는 인증만 지원합니다. 자세한 내용은 개인용 액세스 토큰 관리을(를) 참조하세요.

Warning

Closing down notice: Projects (classic) is being deprecated in favor of the new Projects experience. See the changelog for more information.

"List project collaborators"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합 중 하나 이상이 있어야 합니다.:

  • "Projects" repository permissions (write)
  • "Projects" organization permissions (admin)

"List project collaborators"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.+json is recommended.

경로 매개 변수
project_id integer Required

The unique identifier of the project.

쿼리 매개 변수
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.

기본값: all

다음 중 하나일 수 있습니다.: outside, direct, all

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

기본값: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

기본값: 1

"List project collaborators"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"List project collaborators"에 대한 코드 샘플

GHE.com에서 에 액세스하는 경우 api..com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/projects/{project_id}/collaborators
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/projects/PROJECT_ID/collaborators

Response

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

Warning

Closing down notice: Projects (classic) is being deprecated in favor of the new Projects experience. See the changelog for more information.

"Add project collaborator"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합 중 하나 이상이 있어야 합니다.:

  • "Projects" repository permissions (write)
  • "Projects" organization permissions (admin)

"Add project collaborator"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.+json is recommended.

경로 매개 변수
project_id integer Required

The unique identifier of the project.

username string Required

The handle for the user account.

본문 매개 변수
permission string

The permission to grant the collaborator.

기본값: write

다음 중 하나일 수 있습니다.: read, write, admin

"Add project collaborator"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Add project collaborator"에 대한 코드 샘플

GHE.com에서 에 액세스하는 경우 api..com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

put/projects/{project_id}/collaborators/{username}
curl -L \ -X PUT \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/projects/PROJECT_ID/collaborators/USERNAME \ -d '{"permission":"write"}'

Response

Status: 204

Warning

Closing down notice: Projects (classic) is being deprecated in favor of the new Projects experience. See the changelog for more information.

"Remove user as a collaborator"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합 중 하나 이상이 있어야 합니다.:

  • "Projects" repository permissions (write)
  • "Projects" organization permissions (admin)

"Remove user as a collaborator"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.+json is recommended.

경로 매개 변수
project_id integer Required

The unique identifier of the project.

username string Required

The handle for the user account.

"Remove user as a collaborator"에 대한 HTTP 응답 상태 코드

상태 코드설명
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Remove user as a collaborator"에 대한 코드 샘플

GHE.com에서 에 액세스하는 경우 api..com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

delete/projects/{project_id}/collaborators/{username}
curl -L \ -X DELETE \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/projects/PROJECT_ID/collaborators/USERNAME

Response

Status: 204

Warning

Closing down notice: Projects (classic) is being deprecated in favor of the new Projects experience. See the changelog for more information.

"Get project permission for a user"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰에는 다음 권한 집합 중 하나 이상이 있어야 합니다.:

  • "Projects" repository permissions (write)
  • "Projects" organization permissions (admin)

"Get project permission for a user"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.+json is recommended.

경로 매개 변수
project_id integer Required

The unique identifier of the project.

username string Required

The handle for the user account.

"Get project permission for a user"에 대한 HTTP 응답 상태 코드

상태 코드설명
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Get project permission for a user"에 대한 코드 샘플

GHE.com에서 에 액세스하는 경우 api..com을 api.SUBDOMAIN.ghe.com의 엔터프라이즈 전용 하위 도메인으로 바꾸세요.

요청 예제

get/projects/{project_id}/collaborators/{username}/permission
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/projects/PROJECT_ID/collaborators/USERNAME/permission

Response

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