Skip to main content

project_permissions

Overview

Nameproject_permissions
TypeResource
Idgithub.teams.project_permissions

Fields

NameDatatypeDescription
idinteger
namestring
created_atstring
node_idstring
updated_atstring
numberinteger
permissionsobject
statestring
html_urlstring
creatorobjectA GitHub user.
bodystring
organization_permissionstringThe organization permission for this project. Only present when owner is an organization.
owner_urlstring
urlstring
columns_urlstring
privatebooleanWhether the project is private or not. Only present when owner is an organization.

Methods

NameAccessible byRequired ParamsDescription
check_permissions_for_project_in_orgSELECTorg, project_id, team_slugChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
check_permissions_for_project_legacySELECTproject_id, team_idDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
add_or_update_project_permissions_in_orgEXECorg, project_id, team_slugAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
add_or_update_project_permissions_legacyEXECproject_id, team_idDeprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.