Struct roctogen::endpoints::teams::Teams [−][src]
pub struct Teams<'api> { /* fields omitted */ }
Implementations
pub async fn add_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsAddMemberLegacyError>
pub async fn add_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsAddMemberLegacyError>
Add team member (Legacy)
The “Add team member” endpoint (described below) is deprecated.
We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they’re changing. The person being added to the team must be a member of the team’s organization.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
Note that you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
GitHub API docs for add_member_legacy
pub fn add_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsAddMemberLegacyError>
pub fn add_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsAddMemberLegacyError>
Add team member (Legacy)
The “Add team member” endpoint (described below) is deprecated.
We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they’re changing. The person being added to the team must be a member of the team’s organization.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
Note that you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
GitHub API docs for add_member_legacy
pub async fn add_or_update_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserInOrg
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserInOrgError>
pub async fn add_or_update_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserInOrg
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserInOrgError>
Add or update team membership for a user
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
An organization owner can add someone who is not part of the team’s organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the “pending” state until the person accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team.
If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}
.
GitHub API docs for add_or_update_membership_for_user_in_org
pub fn add_or_update_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserInOrg
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserInOrgError>
pub fn add_or_update_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserInOrg
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserInOrgError>
Add or update team membership for a user
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
An organization owner can add someone who is not part of the team’s organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the “pending” state until the person accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team.
If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}
.
GitHub API docs for add_or_update_membership_for_user_in_org
pub async fn add_or_update_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserLegacy
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserLegacyError>
pub async fn add_or_update_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserLegacy
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserLegacyError>
Add or update team membership for a user (Legacy)
Deprecation 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 membership for a user endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
If the user is already a member of the team’s organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
If the user is unaffiliated with the team’s organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the “pending” state until the user accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
GitHub API docs for add_or_update_membership_for_user_legacy
pub fn add_or_update_membership_for_user_legacy(
&self,
team_id: i32,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserLegacy
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserLegacyError>
pub fn add_or_update_membership_for_user_legacy(
&self,
team_id: i32,
username: &str,
body: PutTeamsAddOrUpdateMembershipForUserLegacy
) -> Result<TeamMembership, TeamsAddOrUpdateMembershipForUserLegacyError>
Add or update team membership for a user (Legacy)
Deprecation 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 membership for a user endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
If the user is already a member of the team’s organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
If the user is unaffiliated with the team’s organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the “pending” state until the user accepts the invitation, at which point the membership will transition to the “active” state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
If the user is already a member of the team, this endpoint will update the role of the team member’s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
GitHub API docs for add_or_update_membership_for_user_legacy
pub async fn add_or_update_project_permissions_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateProjectPermissionsInOrgError>
pub async fn add_or_update_project_permissions_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateProjectPermissionsInOrgError>
Add or update team project permissions
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}
.
GitHub API docs for add_or_update_project_permissions_in_org
pub fn add_or_update_project_permissions_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateProjectPermissionsInOrgError>
pub fn add_or_update_project_permissions_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateProjectPermissionsInOrgError>
Add or update team project permissions
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}
.
GitHub API docs for add_or_update_project_permissions_in_org
pub async fn add_or_update_project_permissions_legacy_async(
&self,
team_id: i32,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateProjectPermissionsLegacyError>
pub async fn add_or_update_project_permissions_legacy_async(
&self,
team_id: i32,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateProjectPermissionsLegacyError>
Add or update team project permissions (Legacy)
Deprecation 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.
GitHub API docs for add_or_update_project_permissions_legacy
pub fn add_or_update_project_permissions_legacy(
&self,
team_id: i32,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateProjectPermissionsLegacyError>
pub fn add_or_update_project_permissions_legacy(
&self,
team_id: i32,
project_id: i32,
body: PutTeamsAddOrUpdateProjectPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateProjectPermissionsLegacyError>
Add or update team project permissions (Legacy)
Deprecation 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.
GitHub API docs for add_or_update_project_permissions_legacy
pub async fn add_or_update_repo_permissions_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateRepoPermissionsInOrgError>
pub async fn add_or_update_repo_permissions_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateRepoPermissionsInOrgError>
Add or update team repository permissions
To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see “Repository permission levels for an organization”.
GitHub API docs for add_or_update_repo_permissions_in_org
pub fn add_or_update_repo_permissions_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateRepoPermissionsInOrgError>
pub fn add_or_update_repo_permissions_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsInOrg
) -> Result<(), TeamsAddOrUpdateRepoPermissionsInOrgError>
Add or update team repository permissions
To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
Note: You can also specify a team by org_id
and team_id
using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
For more information about the permission levels, see “Repository permission levels for an organization”.
GitHub API docs for add_or_update_repo_permissions_in_org
pub async fn add_or_update_repo_permissions_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateRepoPermissionsLegacyError>
pub async fn add_or_update_repo_permissions_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateRepoPermissionsLegacyError>
Add or update team repository permissions (Legacy)
Deprecation 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 repository permissions” endpoint.
To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
GitHub API docs for add_or_update_repo_permissions_legacy
pub fn add_or_update_repo_permissions_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateRepoPermissionsLegacyError>
pub fn add_or_update_repo_permissions_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str,
body: PutTeamsAddOrUpdateRepoPermissionsLegacy
) -> Result<(), TeamsAddOrUpdateRepoPermissionsLegacyError>
Add or update team repository permissions (Legacy)
Deprecation 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 repository permissions” endpoint.
To add a repository to a team or update the team’s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity
status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you’ll need to set Content-Length
to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
GitHub API docs for add_or_update_repo_permissions_legacy
pub async fn check_permissions_for_project_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectInOrgError>
pub async fn check_permissions_for_project_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectInOrgError>
Check team permissions for a project
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}
.
GitHub API docs for check_permissions_for_project_in_org
pub fn check_permissions_for_project_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectInOrgError>
pub fn check_permissions_for_project_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectInOrgError>
Check team permissions for a project
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}
.
GitHub API docs for check_permissions_for_project_in_org
pub async fn check_permissions_for_project_legacy_async(
&self,
team_id: i32,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectLegacyError>
pub async fn check_permissions_for_project_legacy_async(
&self,
team_id: i32,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectLegacyError>
Check team permissions for a project (Legacy)
Deprecation 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.
GitHub API docs for check_permissions_for_project_legacy
pub fn check_permissions_for_project_legacy(
&self,
team_id: i32,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectLegacyError>
pub fn check_permissions_for_project_legacy(
&self,
team_id: i32,
project_id: i32
) -> Result<TeamProject, TeamsCheckPermissionsForProjectLegacyError>
Check team permissions for a project (Legacy)
Deprecation 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.
GitHub API docs for check_permissions_for_project_legacy
pub async fn check_permissions_for_repo_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoInOrgError>
pub async fn check_permissions_for_repo_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoInOrgError>
Check team permissions for a repository
Checks whether a team has admin
, push
, maintain
, triage
, or pull
permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json
accept header.
If a team doesn’t have permission for the repository, you will receive a 404 Not Found
response status.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
GitHub API docs for check_permissions_for_repo_in_org
pub fn check_permissions_for_repo_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoInOrgError>
pub fn check_permissions_for_repo_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoInOrgError>
Check team permissions for a repository
Checks whether a team has admin
, push
, maintain
, triage
, or pull
permission for a repository. Repositories inherited through a parent team will also be checked.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json
accept header.
If a team doesn’t have permission for the repository, you will receive a 404 Not Found
response status.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
GitHub API docs for check_permissions_for_repo_in_org
pub async fn check_permissions_for_repo_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoLegacyError>
pub async fn check_permissions_for_repo_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoLegacyError>
Check team permissions for a repository (Legacy)
Note: Repositories inherited through a parent team will also be checked.
Deprecation 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 repository endpoint.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept
header:
GitHub API docs for check_permissions_for_repo_legacy
pub fn check_permissions_for_repo_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoLegacyError>
pub fn check_permissions_for_repo_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<TeamRepository, TeamsCheckPermissionsForRepoLegacyError>
Check team permissions for a repository (Legacy)
Note: Repositories inherited through a parent team will also be checked.
Deprecation 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 repository endpoint.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept
header:
GitHub API docs for check_permissions_for_repo_legacy
pub async fn create_async(
&self,
org: &str,
body: PostTeamsCreate
) -> Result<TeamFull, TeamsCreateError>
pub async fn create_async(
&self,
org: &str,
body: PostTeamsCreate
) -> Result<TeamFull, TeamsCreateError>
Create a team
To create a team, the authenticated user must be a member or owner of {org}
. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see “Setting team creation permissions.”
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers
. For more information, see “About teams”.
Create a team
To create a team, the authenticated user must be a member or owner of {org}
. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see “Setting team creation permissions.”
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers
. For more information, see “About teams”.
pub async fn create_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentInOrgError>
pub async fn create_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentInOrgError>
Create a discussion comment
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
GitHub API docs for create_discussion_comment_in_org
pub fn create_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentInOrgError>
pub fn create_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentInOrgError>
Create a discussion comment
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
GitHub API docs for create_discussion_comment_in_org
pub async fn create_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentLegacyError>
pub async fn create_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentLegacyError>
Create a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
GitHub API docs for create_discussion_comment_legacy
pub fn create_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentLegacyError>
pub fn create_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
body: PostTeamsCreateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsCreateDiscussionCommentLegacyError>
Create a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
GitHub API docs for create_discussion_comment_legacy
pub async fn create_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PostTeamsCreateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsCreateDiscussionInOrgError>
pub async fn create_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PostTeamsCreateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsCreateDiscussionInOrgError>
Create a discussion
Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions
.
GitHub API docs for create_discussion_in_org
pub fn create_discussion_in_org(
&self,
org: &str,
team_slug: &str,
body: PostTeamsCreateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsCreateDiscussionInOrgError>
pub fn create_discussion_in_org(
&self,
org: &str,
team_slug: &str,
body: PostTeamsCreateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsCreateDiscussionInOrgError>
Create a discussion
Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions
.
GitHub API docs for create_discussion_in_org
pub async fn create_discussion_legacy_async(
&self,
team_id: i32,
body: PostTeamsCreateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsCreateDiscussionLegacyError>
pub async fn create_discussion_legacy_async(
&self,
team_id: i32,
body: PostTeamsCreateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsCreateDiscussionLegacyError>
Create a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion
endpoint.
Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
GitHub API docs for create_discussion_legacy
pub fn create_discussion_legacy(
&self,
team_id: i32,
body: PostTeamsCreateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsCreateDiscussionLegacyError>
pub fn create_discussion_legacy(
&self,
team_id: i32,
body: PostTeamsCreateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsCreateDiscussionLegacyError>
Create a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion
endpoint.
Creates a new discussion post on a team’s page. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See “Secondary rate limits” and “Dealing with secondary rate limits” for details.
GitHub API docs for create_discussion_legacy
pub async fn create_or_update_idp_group_connections_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsInOrg
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsInOrgError>
pub async fn create_or_update_idp_group_connections_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsInOrg
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsInOrgError>
Create or update IdP group connections
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups
array will remove all connections for a team.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings
.
GitHub API docs for create_or_update_idp_group_connections_in_org
pub fn create_or_update_idp_group_connections_in_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsInOrg
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsInOrgError>
pub fn create_or_update_idp_group_connections_in_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsInOrg
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsInOrgError>
Create or update IdP group connections
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups
array will remove all connections for a team.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings
.
GitHub API docs for create_or_update_idp_group_connections_in_org
pub async fn create_or_update_idp_group_connections_legacy_async(
&self,
team_id: i32,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsLegacy
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsLegacyError>
pub async fn create_or_update_idp_group_connections_legacy_async(
&self,
team_id: i32,
body: PatchTeamsCreateOrUpdateIdpGroupConnectionsLegacy
) -> Result<GroupMapping, TeamsCreateOrUpdateIdpGroupConnectionsLegacyError>
Create or update IdP group connections (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections
endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups
array will remove all connections for a team.
GitHub API docs for create_or_update_idp_group_connections_legacy
Create or update IdP group connections (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections
endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups
array will remove all connections for a team.
GitHub API docs for create_or_update_idp_group_connections_legacy
pub async fn delete_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentInOrgError>
pub async fn delete_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentInOrgError>
Delete a discussion comment
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for delete_discussion_comment_in_org
pub fn delete_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentInOrgError>
pub fn delete_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentInOrgError>
Delete a discussion comment
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for delete_discussion_comment_in_org
pub async fn delete_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentLegacyError>
pub async fn delete_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentLegacyError>
Delete a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
GitHub API docs for delete_discussion_comment_legacy
pub fn delete_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentLegacyError>
pub fn delete_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<(), TeamsDeleteDiscussionCommentLegacyError>
Delete a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
GitHub API docs for delete_discussion_comment_legacy
pub async fn delete_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionInOrgError>
pub async fn delete_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionInOrgError>
Delete a discussion
Delete a discussion from a team’s page. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for delete_discussion_in_org
pub fn delete_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionInOrgError>
pub fn delete_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionInOrgError>
Delete a discussion
Delete a discussion from a team’s page. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for delete_discussion_in_org
pub async fn delete_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionLegacyError>
pub async fn delete_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionLegacyError>
Delete a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion
endpoint.
Delete a discussion from a team’s page. OAuth access tokens require the write:discussion
scope.
GitHub API docs for delete_discussion_legacy
pub fn delete_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionLegacyError>
pub fn delete_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32
) -> Result<(), TeamsDeleteDiscussionLegacyError>
Delete a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion
endpoint.
Delete a discussion from a team’s page. OAuth access tokens require the write:discussion
scope.
GitHub API docs for delete_discussion_legacy
pub async fn delete_in_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsDeleteInOrgError>
pub async fn delete_in_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsDeleteInOrgError>
Delete a team
To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}
.
GitHub API docs for delete_in_org
Delete a team
To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}
.
GitHub API docs for delete_in_org
Delete a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
GitHub API docs for delete_legacy
Delete a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a team endpoint.
To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
GitHub API docs for delete_legacy
pub async fn external_idp_group_info_for_org_async(
&self,
org: &str,
group_id: i32
) -> Result<ExternalGroup, TeamsExternalIdpGroupInfoForOrgError>
pub async fn external_idp_group_info_for_org_async(
&self,
org: &str,
group_id: i32
) -> Result<ExternalGroup, TeamsExternalIdpGroupInfoForOrgError>
Get an external group
Displays information about the specific group’s usage. Provides a list of the group’s external members as well as a list of teams that this group is connected to.
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for external_idp_group_info_for_org
pub fn external_idp_group_info_for_org(
&self,
org: &str,
group_id: i32
) -> Result<ExternalGroup, TeamsExternalIdpGroupInfoForOrgError>
pub fn external_idp_group_info_for_org(
&self,
org: &str,
group_id: i32
) -> Result<ExternalGroup, TeamsExternalIdpGroupInfoForOrgError>
Get an external group
Displays information about the specific group’s usage. Provides a list of the group’s external members as well as a list of teams that this group is connected to.
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for external_idp_group_info_for_org
pub async fn get_by_name_async(
&self,
org: &str,
team_slug: &str
) -> Result<TeamFull, TeamsGetByNameError>
pub async fn get_by_name_async(
&self,
org: &str,
team_slug: &str
) -> Result<TeamFull, TeamsGetByNameError>
Get a team by name
Gets a team using the team’s slug
. GitHub generates the slug
from the team name
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}
.
GitHub API docs for get_by_name
pub fn get_by_name(
&self,
org: &str,
team_slug: &str
) -> Result<TeamFull, TeamsGetByNameError>
pub fn get_by_name(
&self,
org: &str,
team_slug: &str
) -> Result<TeamFull, TeamsGetByNameError>
Get a team by name
Gets a team using the team’s slug
. GitHub generates the slug
from the team name
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}
.
GitHub API docs for get_by_name
pub async fn get_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentInOrgError>
pub async fn get_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentInOrgError>
Get a discussion comment
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for get_discussion_comment_in_org
pub fn get_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentInOrgError>
pub fn get_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentInOrgError>
Get a discussion comment
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for get_discussion_comment_in_org
pub async fn get_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentLegacyError>
pub async fn get_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentLegacyError>
Get a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion
scope.
GitHub API docs for get_discussion_comment_legacy
pub fn get_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentLegacyError>
pub fn get_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32
) -> Result<TeamDiscussionComment, TeamsGetDiscussionCommentLegacyError>
Get a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion
scope.
GitHub API docs for get_discussion_comment_legacy
pub async fn get_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionInOrgError>
pub async fn get_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionInOrgError>
Get a discussion
Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for get_discussion_in_org
pub fn get_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionInOrgError>
pub fn get_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionInOrgError>
Get a discussion
Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for get_discussion_in_org
pub async fn get_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionLegacyError>
pub async fn get_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionLegacyError>
Get a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion
scope.
GitHub API docs for get_discussion_legacy
pub fn get_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionLegacyError>
pub fn get_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32
) -> Result<TeamDiscussion, TeamsGetDiscussionLegacyError>
Get a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion endpoint.
Get a specific discussion on a team’s page. OAuth access tokens require the read:discussion
scope.
GitHub API docs for get_discussion_legacy
Get a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
GitHub API docs for get_legacy
Get a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the Get a team by name endpoint.
GitHub API docs for get_legacy
pub async fn get_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsGetMemberLegacyError>
pub async fn get_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsGetMemberLegacyError>
Get team member (Legacy)
The “Get team member” endpoint (described below) is deprecated.
We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
To list members in a team, the team must be visible to the authenticated user.
GitHub API docs for get_member_legacy
pub fn get_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsGetMemberLegacyError>
pub fn get_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsGetMemberLegacyError>
Get team member (Legacy)
The “Get team member” endpoint (described below) is deprecated.
We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
To list members in a team, the team must be visible to the authenticated user.
GitHub API docs for get_member_legacy
pub async fn get_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserInOrgError>
pub async fn get_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserInOrgError>
Get team membership for a user
Team members will include the members of child teams.
To get a user’s membership with a team, the team must be visible to the authenticated user.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Note:
The response contains the state
of the membership and the member’s role
.
The role
for organization owners is set to maintainer
. For more information about maintainer
roles, see see Create a team.
GitHub API docs for get_membership_for_user_in_org
pub fn get_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserInOrgError>
pub fn get_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserInOrgError>
Get team membership for a user
Team members will include the members of child teams.
To get a user’s membership with a team, the team must be visible to the authenticated user.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}
.
Note:
The response contains the state
of the membership and the member’s role
.
The role
for organization owners is set to maintainer
. For more information about maintainer
roles, see see Create a team.
GitHub API docs for get_membership_for_user_in_org
pub async fn get_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserLegacyError>
pub async fn get_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserLegacyError>
Get team membership for a user (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
Team members will include the members of child teams.
To get a user’s membership with a team, the team must be visible to the authenticated user.
Note:
The response contains the state
of the membership and the member’s role
.
The role
for organization owners is set to maintainer
. For more information about maintainer
roles, see Create a team.
GitHub API docs for get_membership_for_user_legacy
pub fn get_membership_for_user_legacy(
&self,
team_id: i32,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserLegacyError>
pub fn get_membership_for_user_legacy(
&self,
team_id: i32,
username: &str
) -> Result<TeamMembership, TeamsGetMembershipForUserLegacyError>
Get team membership for a user (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Get team membership for a user endpoint.
Team members will include the members of child teams.
To get a user’s membership with a team, the team must be visible to the authenticated user.
Note:
The response contains the state
of the membership and the member’s role
.
The role
for organization owners is set to maintainer
. For more information about maintainer
roles, see Create a team.
GitHub API docs for get_membership_for_user_legacy
pub async fn link_external_idp_group_to_team_for_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsLinkExternalIdpGroupToTeamForOrg
) -> Result<ExternalGroup, TeamsLinkExternalIdpGroupToTeamForOrgError>
pub async fn link_external_idp_group_to_team_for_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsLinkExternalIdpGroupToTeamForOrg
) -> Result<ExternalGroup, TeamsLinkExternalIdpGroupToTeamForOrgError>
Update the connection between an external group and a team
Creates a connection between a team and an external group. Only one external group can be linked to a team.
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for link_external_idp_group_to_team_for_org
pub fn link_external_idp_group_to_team_for_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsLinkExternalIdpGroupToTeamForOrg
) -> Result<ExternalGroup, TeamsLinkExternalIdpGroupToTeamForOrgError>
pub fn link_external_idp_group_to_team_for_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsLinkExternalIdpGroupToTeamForOrg
) -> Result<ExternalGroup, TeamsLinkExternalIdpGroupToTeamForOrgError>
Update the connection between an external group and a team
Creates a connection between a team and an external group. Only one external group can be linked to a team.
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for link_external_idp_group_to_team_for_org
pub async fn list_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListParams>>
) -> Result<Vec<Team>, TeamsListError>
pub async fn list_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListParams>>
) -> Result<Vec<Team>, TeamsListError>
pub fn list(
&self,
org: &str,
query_params: Option<impl Into<TeamsListParams>>
) -> Result<Vec<Team>, TeamsListError>
pub fn list(
&self,
org: &str,
query_params: Option<impl Into<TeamsListParams>>
) -> Result<Vec<Team>, TeamsListError>
pub async fn list_child_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListChildInOrgParams>>
) -> Result<Vec<Team>, TeamsListChildInOrgError>
pub async fn list_child_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListChildInOrgParams>>
) -> Result<Vec<Team>, TeamsListChildInOrgError>
List child teams
Lists the child teams of the team specified by {team_slug}
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/teams
.
GitHub API docs for list_child_in_org
pub fn list_child_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListChildInOrgParams>>
) -> Result<Vec<Team>, TeamsListChildInOrgError>
pub fn list_child_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListChildInOrgParams>>
) -> Result<Vec<Team>, TeamsListChildInOrgError>
List child teams
Lists the child teams of the team specified by {team_slug}
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/teams
.
GitHub API docs for list_child_in_org
pub async fn list_child_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListChildLegacyParams>>
) -> Result<Vec<Team>, TeamsListChildLegacyError>
pub async fn list_child_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListChildLegacyParams>>
) -> Result<Vec<Team>, TeamsListChildLegacyError>
List child teams (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams
endpoint.
GitHub API docs for list_child_legacy
pub fn list_child_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListChildLegacyParams>>
) -> Result<Vec<Team>, TeamsListChildLegacyError>
pub fn list_child_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListChildLegacyParams>>
) -> Result<Vec<Team>, TeamsListChildLegacyError>
List child teams (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List child teams
endpoint.
GitHub API docs for list_child_legacy
pub async fn list_discussion_comments_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsInOrgError>
pub async fn list_discussion_comments_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsInOrgError>
List discussion comments
List all comments on a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
GitHub API docs for list_discussion_comments_in_org
pub fn list_discussion_comments_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsInOrgError>
pub fn list_discussion_comments_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsInOrgError>
List discussion comments
List all comments on a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
GitHub API docs for list_discussion_comments_in_org
pub async fn list_discussion_comments_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsLegacyError>
pub async fn list_discussion_comments_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsLegacyError>
List discussion comments (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
List all comments on a team discussion. OAuth access tokens require the read:discussion
scope.
GitHub API docs for list_discussion_comments_legacy
pub fn list_discussion_comments_legacy(
&self,
team_id: i32,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsLegacyError>
pub fn list_discussion_comments_legacy(
&self,
team_id: i32,
discussion_number: i32,
query_params: Option<impl Into<TeamsListDiscussionCommentsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussionComment>, TeamsListDiscussionCommentsLegacyError>
List discussion comments (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
List all comments on a team discussion. OAuth access tokens require the read:discussion
scope.
GitHub API docs for list_discussion_comments_legacy
pub async fn list_discussions_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListDiscussionsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsInOrgError>
pub async fn list_discussions_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListDiscussionsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsInOrgError>
List discussions
List all discussions on a team’s page. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions
.
GitHub API docs for list_discussions_in_org
pub fn list_discussions_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListDiscussionsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsInOrgError>
pub fn list_discussions_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListDiscussionsInOrgParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsInOrgError>
List discussions
List all discussions on a team’s page. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions
.
GitHub API docs for list_discussions_in_org
pub async fn list_discussions_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListDiscussionsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsLegacyError>
pub async fn list_discussions_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListDiscussionsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsLegacyError>
List discussions (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions
endpoint.
List all discussions on a team’s page. OAuth access tokens require the read:discussion
scope.
GitHub API docs for list_discussions_legacy
pub fn list_discussions_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListDiscussionsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsLegacyError>
pub fn list_discussions_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListDiscussionsLegacyParams<'api>>>
) -> Result<Vec<TeamDiscussion>, TeamsListDiscussionsLegacyError>
List discussions (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussions
endpoint.
List all discussions on a team’s page. OAuth access tokens require the read:discussion
scope.
GitHub API docs for list_discussions_legacy
pub async fn list_external_idp_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListExternalIdpGroupsForOrgParams<'api>>>
) -> Result<ExternalGroups, TeamsListExternalIdpGroupsForOrgError>
pub async fn list_external_idp_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListExternalIdpGroupsForOrgParams<'api>>>
) -> Result<ExternalGroups, TeamsListExternalIdpGroupsForOrgError>
List external groups in an organization
Lists external groups available in an organization. You can query the groups using the display_name
parameter, only groups with a group_name
containing the text provided in the display_name
parameter will be returned. You can also limit your page results using the per_page
parameter. GitHub generates a url-encoded page
token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for list_external_idp_groups_for_org
pub fn list_external_idp_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<TeamsListExternalIdpGroupsForOrgParams<'api>>>
) -> Result<ExternalGroups, TeamsListExternalIdpGroupsForOrgError>
pub fn list_external_idp_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<TeamsListExternalIdpGroupsForOrgParams<'api>>>
) -> Result<ExternalGroups, TeamsListExternalIdpGroupsForOrgError>
List external groups in an organization
Lists external groups available in an organization. You can query the groups using the display_name
parameter, only groups with a group_name
containing the text provided in the display_name
parameter will be returned. You can also limit your page results using the per_page
parameter. GitHub generates a url-encoded page
token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see “GitHub’s products” in the GitHub Help documentation.
GitHub API docs for list_external_idp_groups_for_org
pub async fn list_for_authenticated_user_async(
&self,
query_params: Option<impl Into<TeamsListForAuthenticatedUserParams>>
) -> Result<Vec<TeamFull>, TeamsListForAuthenticatedUserError>
pub async fn list_for_authenticated_user_async(
&self,
query_params: Option<impl Into<TeamsListForAuthenticatedUserParams>>
) -> Result<Vec<TeamFull>, TeamsListForAuthenticatedUserError>
List teams for the authenticated user
List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user
, repo
, or read:org
scope when authenticating via OAuth.
GitHub API docs for list_for_authenticated_user
pub fn list_for_authenticated_user(
&self,
query_params: Option<impl Into<TeamsListForAuthenticatedUserParams>>
) -> Result<Vec<TeamFull>, TeamsListForAuthenticatedUserError>
pub fn list_for_authenticated_user(
&self,
query_params: Option<impl Into<TeamsListForAuthenticatedUserParams>>
) -> Result<Vec<TeamFull>, TeamsListForAuthenticatedUserError>
List teams for the authenticated user
List all of the teams across all of the organizations to which the authenticated user belongs. This method requires user
, repo
, or read:org
scope when authenticating via OAuth.
GitHub API docs for list_for_authenticated_user
pub async fn list_idp_groups_for_legacy_async(
&self,
team_id: i32
) -> Result<GroupMapping, TeamsListIdpGroupsForLegacyError>
pub async fn list_idp_groups_for_legacy_async(
&self,
team_id: i32
) -> Result<GroupMapping, TeamsListIdpGroupsForLegacyError>
List IdP groups for a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team
endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups connected to a team on GitHub.
GitHub API docs for list_idp_groups_for_legacy
pub fn list_idp_groups_for_legacy(
&self,
team_id: i32
) -> Result<GroupMapping, TeamsListIdpGroupsForLegacyError>
pub fn list_idp_groups_for_legacy(
&self,
team_id: i32
) -> Result<GroupMapping, TeamsListIdpGroupsForLegacyError>
List IdP groups for a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team
endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups connected to a team on GitHub.
GitHub API docs for list_idp_groups_for_legacy
pub async fn list_idp_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListIdpGroupsForOrgParams>>
) -> Result<GroupMapping, TeamsListIdpGroupsForOrgError>
pub async fn list_idp_groups_for_org_async(
&self,
org: &str,
query_params: Option<impl Into<TeamsListIdpGroupsForOrgParams>>
) -> Result<GroupMapping, TeamsListIdpGroupsForOrgError>
List IdP groups for an organization
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups available in an organization. You can limit your page results using the per_page
parameter. GitHub generates a url-encoded page
token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”
GitHub API docs for list_idp_groups_for_org
pub fn list_idp_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<TeamsListIdpGroupsForOrgParams>>
) -> Result<GroupMapping, TeamsListIdpGroupsForOrgError>
pub fn list_idp_groups_for_org(
&self,
org: &str,
query_params: Option<impl Into<TeamsListIdpGroupsForOrgParams>>
) -> Result<GroupMapping, TeamsListIdpGroupsForOrgError>
List IdP groups for an organization
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups available in an organization. You can limit your page results using the per_page
parameter. GitHub generates a url-encoded page
token using a cursor value for where the next page begins. For more information on cursor pagination, see “Offset and Cursor Pagination explained.”
GitHub API docs for list_idp_groups_for_org
pub async fn list_idp_groups_in_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<GroupMapping, TeamsListIdpGroupsInOrgError>
pub async fn list_idp_groups_in_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<GroupMapping, TeamsListIdpGroupsInOrgError>
List IdP groups for a team
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups connected to a team on GitHub.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings
.
GitHub API docs for list_idp_groups_in_org
pub fn list_idp_groups_in_org(
&self,
org: &str,
team_slug: &str
) -> Result<GroupMapping, TeamsListIdpGroupsInOrgError>
pub fn list_idp_groups_in_org(
&self,
org: &str,
team_slug: &str
) -> Result<GroupMapping, TeamsListIdpGroupsInOrgError>
List IdP groups for a team
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
List IdP groups connected to a team on GitHub.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings
.
GitHub API docs for list_idp_groups_in_org
pub async fn list_members_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListMembersInOrgParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersInOrgError>
pub async fn list_members_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListMembersInOrgParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersInOrgError>
List team members
Team members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.
GitHub API docs for list_members_in_org
pub fn list_members_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListMembersInOrgParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersInOrgError>
pub fn list_members_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListMembersInOrgParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersInOrgError>
List team members
Team members will include the members of child teams.
To list members in a team, the team must be visible to the authenticated user.
GitHub API docs for list_members_in_org
pub async fn list_members_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListMembersLegacyParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersLegacyError>
pub async fn list_members_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListMembersLegacyParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersLegacyError>
List team members (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members
endpoint.
Team members will include the members of child teams.
GitHub API docs for list_members_legacy
pub fn list_members_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListMembersLegacyParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersLegacyError>
pub fn list_members_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListMembersLegacyParams<'api>>>
) -> Result<Vec<SimpleUser>, TeamsListMembersLegacyError>
List team members (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team members
endpoint.
Team members will include the members of child teams.
GitHub API docs for list_members_legacy
pub async fn list_pending_invitations_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListPendingInvitationsInOrgParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsInOrgError>
pub async fn list_pending_invitations_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListPendingInvitationsInOrgParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsInOrgError>
List pending team invitations
The return hash contains a role
field which refers to the Organization Invitation role and will be one of the following values: direct_member
, admin
, billing_manager
, hiring_manager
, or reinstate
. If the invitee is not a GitHub member, the login
field in the return hash will be null
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/invitations
.
GitHub API docs for list_pending_invitations_in_org
pub fn list_pending_invitations_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListPendingInvitationsInOrgParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsInOrgError>
pub fn list_pending_invitations_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListPendingInvitationsInOrgParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsInOrgError>
List pending team invitations
The return hash contains a role
field which refers to the Organization Invitation role and will be one of the following values: direct_member
, admin
, billing_manager
, hiring_manager
, or reinstate
. If the invitee is not a GitHub member, the login
field in the return hash will be null
.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/invitations
.
GitHub API docs for list_pending_invitations_in_org
pub async fn list_pending_invitations_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListPendingInvitationsLegacyParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsLegacyError>
pub async fn list_pending_invitations_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListPendingInvitationsLegacyParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsLegacyError>
List pending team invitations (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations
endpoint.
The return hash contains a role
field which refers to the Organization Invitation role and will be one of the following values: direct_member
, admin
, billing_manager
, hiring_manager
, or reinstate
. If the invitee is not a GitHub member, the login
field in the return hash will be null
.
GitHub API docs for list_pending_invitations_legacy
pub fn list_pending_invitations_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListPendingInvitationsLegacyParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsLegacyError>
pub fn list_pending_invitations_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListPendingInvitationsLegacyParams>>
) -> Result<Vec<OrganizationInvitation>, TeamsListPendingInvitationsLegacyError>
List pending team invitations (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List pending team invitations
endpoint.
The return hash contains a role
field which refers to the Organization Invitation role and will be one of the following values: direct_member
, admin
, billing_manager
, hiring_manager
, or reinstate
. If the invitee is not a GitHub member, the login
field in the return hash will be null
.
GitHub API docs for list_pending_invitations_legacy
pub async fn list_projects_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListProjectsInOrgParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsInOrgError>
pub async fn list_projects_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListProjectsInOrgParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsInOrgError>
List team projects
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
.
GitHub API docs for list_projects_in_org
pub fn list_projects_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListProjectsInOrgParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsInOrgError>
pub fn list_projects_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListProjectsInOrgParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsInOrgError>
List team projects
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
.
GitHub API docs for list_projects_in_org
pub async fn list_projects_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListProjectsLegacyParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsLegacyError>
pub async fn list_projects_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListProjectsLegacyParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsLegacyError>
List team projects (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects
endpoint.
Lists the organization projects for a team.
GitHub API docs for list_projects_legacy
pub fn list_projects_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListProjectsLegacyParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsLegacyError>
pub fn list_projects_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListProjectsLegacyParams>>
) -> Result<Vec<TeamProject>, TeamsListProjectsLegacyError>
List team projects (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects
endpoint.
Lists the organization projects for a team.
GitHub API docs for list_projects_legacy
pub async fn list_repos_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListReposInOrgParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposInOrgError>
pub async fn list_repos_in_org_async(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListReposInOrgParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposInOrgError>
List team repositories
Lists a team’s repositories visible to the authenticated user.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/repos
.
GitHub API docs for list_repos_in_org
pub fn list_repos_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListReposInOrgParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposInOrgError>
pub fn list_repos_in_org(
&self,
org: &str,
team_slug: &str,
query_params: Option<impl Into<TeamsListReposInOrgParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposInOrgError>
List team repositories
Lists a team’s repositories visible to the authenticated user.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/repos
.
GitHub API docs for list_repos_in_org
pub async fn list_repos_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListReposLegacyParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposLegacyError>
pub async fn list_repos_legacy_async(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListReposLegacyParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposLegacyError>
List team repositories (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
GitHub API docs for list_repos_legacy
pub fn list_repos_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListReposLegacyParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposLegacyError>
pub fn list_repos_legacy(
&self,
team_id: i32,
query_params: Option<impl Into<TeamsListReposLegacyParams>>
) -> Result<Vec<MinimalRepository>, TeamsListReposLegacyError>
List team repositories (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List team repositories endpoint.
GitHub API docs for list_repos_legacy
pub async fn remove_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMemberLegacyError>
pub async fn remove_member_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMemberLegacyError>
Remove team member (Legacy)
The “Remove team member” endpoint (described below) is deprecated.
We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a team member, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
GitHub API docs for remove_member_legacy
pub fn remove_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMemberLegacyError>
pub fn remove_member_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMemberLegacyError>
Remove team member (Legacy)
The “Remove team member” endpoint (described below) is deprecated.
We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a team member, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
GitHub API docs for remove_member_legacy
pub async fn remove_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserInOrgError>
pub async fn remove_membership_for_user_in_org_async(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserInOrgError>
Remove team membership for a user
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}
.
GitHub API docs for remove_membership_for_user_in_org
pub fn remove_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserInOrgError>
pub fn remove_membership_for_user_in_org(
&self,
org: &str,
team_slug: &str,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserInOrgError>
Remove team membership for a user
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}
.
GitHub API docs for remove_membership_for_user_in_org
pub async fn remove_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserLegacyError>
pub async fn remove_membership_for_user_legacy_async(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserLegacyError>
Remove team membership for a user (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
GitHub API docs for remove_membership_for_user_legacy
pub fn remove_membership_for_user_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserLegacyError>
pub fn remove_membership_for_user_legacy(
&self,
team_id: i32,
username: &str
) -> Result<(), TeamsRemoveMembershipForUserLegacyError>
Remove team membership for a user (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove team membership for a user endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
To remove a membership between a user and a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.
Note: When you have team synchronization set up for a team with your organization’s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team’s membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see “Synchronizing teams between your identity provider and GitHub.”
GitHub API docs for remove_membership_for_user_legacy
pub async fn remove_project_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<(), TeamsRemoveProjectInOrgError>
pub async fn remove_project_in_org_async(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<(), TeamsRemoveProjectInOrgError>
Remove a project from a team
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}
.
GitHub API docs for remove_project_in_org
pub fn remove_project_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<(), TeamsRemoveProjectInOrgError>
pub fn remove_project_in_org(
&self,
org: &str,
team_slug: &str,
project_id: i32
) -> Result<(), TeamsRemoveProjectInOrgError>
Remove a project from a team
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}
.
GitHub API docs for remove_project_in_org
pub async fn remove_project_legacy_async(
&self,
team_id: i32,
project_id: i32
) -> Result<(), TeamsRemoveProjectLegacyError>
pub async fn remove_project_legacy_async(
&self,
team_id: i32,
project_id: i32
) -> Result<(), TeamsRemoveProjectLegacyError>
Remove a project from a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
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. Note: This endpoint removes the project from the team, but does not delete it.
GitHub API docs for remove_project_legacy
pub fn remove_project_legacy(
&self,
team_id: i32,
project_id: i32
) -> Result<(), TeamsRemoveProjectLegacyError>
pub fn remove_project_legacy(
&self,
team_id: i32,
project_id: i32
) -> Result<(), TeamsRemoveProjectLegacyError>
Remove a project from a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a project from a team endpoint.
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. Note: This endpoint removes the project from the team, but does not delete it.
GitHub API docs for remove_project_legacy
pub async fn remove_repo_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoInOrgError>
pub async fn remove_repo_in_org_async(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoInOrgError>
Remove a repository from a team
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
GitHub API docs for remove_repo_in_org
pub fn remove_repo_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoInOrgError>
pub fn remove_repo_in_org(
&self,
org: &str,
team_slug: &str,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoInOrgError>
Remove a repository from a team
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.
Note: You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}
.
GitHub API docs for remove_repo_in_org
pub async fn remove_repo_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoLegacyError>
pub async fn remove_repo_legacy_async(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoLegacyError>
Remove a repository from a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
GitHub API docs for remove_repo_legacy
pub fn remove_repo_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoLegacyError>
pub fn remove_repo_legacy(
&self,
team_id: i32,
owner: &str,
repo: &str
) -> Result<(), TeamsRemoveRepoLegacyError>
Remove a repository from a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Remove a repository from a team endpoint.
If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
GitHub API docs for remove_repo_legacy
pub async fn unlink_external_idp_group_from_team_for_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsUnlinkExternalIdpGroupFromTeamForOrgError>
pub async fn unlink_external_idp_group_from_team_for_org_async(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsUnlinkExternalIdpGroupFromTeamForOrgError>
Remove the connection between an external group and a team
Deletes a connection between a team and an external group.
You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
GitHub API docs for unlink_external_idp_group_from_team_for_org
pub fn unlink_external_idp_group_from_team_for_org(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsUnlinkExternalIdpGroupFromTeamForOrgError>
pub fn unlink_external_idp_group_from_team_for_org(
&self,
org: &str,
team_slug: &str
) -> Result<(), TeamsUnlinkExternalIdpGroupFromTeamForOrgError>
Remove the connection between an external group and a team
Deletes a connection between a team and an external group.
You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation.
GitHub API docs for unlink_external_idp_group_from_team_for_org
pub async fn update_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentInOrgError>
pub async fn update_discussion_comment_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentInOrgError>
Update a discussion comment
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for update_discussion_comment_in_org
pub fn update_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentInOrgError>
pub fn update_discussion_comment_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentInOrg
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentInOrgError>
Update a discussion comment
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
GitHub API docs for update_discussion_comment_in_org
pub async fn update_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentLegacyError>
pub async fn update_discussion_comment_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentLegacyError>
Update a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion
scope.
GitHub API docs for update_discussion_comment_legacy
pub fn update_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentLegacyError>
pub fn update_discussion_comment_legacy(
&self,
team_id: i32,
discussion_number: i32,
comment_number: i32,
body: PatchTeamsUpdateDiscussionCommentLegacy
) -> Result<TeamDiscussionComment, TeamsUpdateDiscussionCommentLegacyError>
Update a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion
scope.
GitHub API docs for update_discussion_comment_legacy
pub async fn update_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsUpdateDiscussionInOrgError>
pub async fn update_discussion_in_org_async(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsUpdateDiscussionInOrgError>
Update a discussion
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for update_discussion_in_org
pub fn update_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsUpdateDiscussionInOrgError>
pub fn update_discussion_in_org(
&self,
org: &str,
team_slug: &str,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionInOrg
) -> Result<TeamDiscussion, TeamsUpdateDiscussionInOrgError>
Update a discussion
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}
.
GitHub API docs for update_discussion_in_org
pub async fn update_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsUpdateDiscussionLegacyError>
pub async fn update_discussion_legacy_async(
&self,
team_id: i32,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsUpdateDiscussionLegacyError>
Update a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion
scope.
GitHub API docs for update_discussion_legacy
pub fn update_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsUpdateDiscussionLegacyError>
pub fn update_discussion_legacy(
&self,
team_id: i32,
discussion_number: i32,
body: PatchTeamsUpdateDiscussionLegacy
) -> Result<TeamDiscussion, TeamsUpdateDiscussionLegacyError>
Update a discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion
scope.
GitHub API docs for update_discussion_legacy
pub async fn update_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsUpdateInOrg
) -> Result<TeamFull, TeamsUpdateInOrgError>
pub async fn update_in_org_async(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsUpdateInOrg
) -> Result<TeamFull, TeamsUpdateInOrgError>
Update a team
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}
.
GitHub API docs for update_in_org
pub fn update_in_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsUpdateInOrg
) -> Result<TeamFull, TeamsUpdateInOrgError>
pub fn update_in_org(
&self,
org: &str,
team_slug: &str,
body: PatchTeamsUpdateInOrg
) -> Result<TeamFull, TeamsUpdateInOrgError>
Update a team
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
Note: You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}
.
GitHub API docs for update_in_org
pub async fn update_legacy_async(
&self,
team_id: i32,
body: PatchTeamsUpdateLegacy
) -> Result<TeamFull, TeamsUpdateLegacyError>
pub async fn update_legacy_async(
&self,
team_id: i32,
body: PatchTeamsUpdateLegacy
) -> Result<TeamFull, TeamsUpdateLegacyError>
Update a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
Note: With nested teams, the privacy
for parent teams cannot be secret
.
GitHub API docs for update_legacy
pub fn update_legacy(
&self,
team_id: i32,
body: PatchTeamsUpdateLegacy
) -> Result<TeamFull, TeamsUpdateLegacyError>
pub fn update_legacy(
&self,
team_id: i32,
body: PatchTeamsUpdateLegacy
) -> Result<TeamFull, TeamsUpdateLegacyError>
Update a team (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a team endpoint.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
Note: With nested teams, the privacy
for parent teams cannot be secret
.
GitHub API docs for update_legacy