projects
Overview
Name | projects |
Type | Resource |
Id | github.teams.projects |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | |
name | string | |
url | string | |
columns_url | string | |
html_url | string | |
node_id | string | |
private | boolean | Whether the project is private or not. Only present when owner is an organization. |
number | integer | |
body | string | |
owner_url | string | |
creator | object | Simple User |
organization_permission | string | The organization permission for this project. Only present when owner is an organization. |
updated_at | string | |
created_at | string | |
permissions | object | |
state | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
list_projects_in_org | SELECT | org, team_slug | Lists the organization projects for a 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 . |
add_or_update_project_permissions_in_org | INSERT | org, project_id, team_slug | 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.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} . |
remove_project_in_org | DELETE | org, project_id, team_slug | Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id} . |
check_permissions_for_project_in_org | EXEC | org, project_id, team_slug | Checks 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} . |