REST-API-Endpunkte für Project (classic)-Projektmitarbeiter

Hinweise:

Diese Endpunkte interagieren nur mit projects (classic). Verwende zum Verwalten von Projects die GraphQL-API. Weitere Informationen findest du unter Verwalten von Projects mit der API.
Zum Erstellen eines neuen Projekt (klassisch) muss die Organisation, der Benutzer oder das Repository bereits über mindestens ein Projekt (klassisch) verfügen.

Die REST-API zum Verwalten von projects (classic) unterstützt ausschließlich die Authentifizierung mit einem personal access token (classic). Weitere Informationen findest du unter Verwalten deiner persönlichen Zugriffstoken.

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.

Differenzierte Zugriffstoken für "List project collaborators"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

repository_projects:write
organization_projects:admin

Parameter für „List project collaborators“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`project_id` integer Erforderlich The unique identifier of the project.

Abfrageparameter
Name, type, BESCHREIBUNG
`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. Standard: `all` Kann eine der Folgenden sein: `outside`, `direct`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List project collaborators“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „List project collaborators“

Beispiel für eine Anfrage

get/projects/{project_id}/collaborators

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

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.

Differenzierte Zugriffstoken für "Add project collaborator"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

repository_projects:write
organization_projects:admin

Parameter für „Add project collaborator“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`project_id` integer Erforderlich The unique identifier of the project.
`username` string Erforderlich The handle for the GitHub user account.

Textparameter
Name, type, BESCHREIBUNG
`permission` string The permission to grant the collaborator. Standard: `write` Kann eine der Folgenden sein: `read`, `write`, `admin`

HTTP-Antwortstatuscodes für „Add project collaborator“

Statuscode	BESCHREIBUNG
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Add project collaborator“

Beispiel für eine Anfrage

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

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

Response

Status: 204

Remove user as a collaborator

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

Differenzierte Zugriffstoken für "Remove user as a collaborator"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

repository_projects:write
organization_projects:admin

Parameter für „Remove user as a collaborator“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`project_id` integer Erforderlich The unique identifier of the project.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove user as a collaborator“

Statuscode	BESCHREIBUNG
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Remove user as a collaborator“

Beispiel für eine Anfrage

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

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

Response

Status: 204

Get project permission for a user

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.

Differenzierte Zugriffstoken für "Get project permission for a user"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

Das Token muss mindestens einen der folgenden Berechtigungssätze aufweisen.:

repository_projects:write
organization_projects:admin

Parameter für „Get project permission for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`project_id` integer Erforderlich The unique identifier of the project.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Get project permission for a user“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Get project permission for a user“

Beispiel für eine Anfrage

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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
  }
}