provider enterprise-teams PATCH /enterprises/{enterprise}/teams/{team_slug}
@utdk/github /enterprises/{enterprise}/teams/{team_slug}
Update an enterprise team
To edit a team, the authenticated user must be an enterprise owner.
enterprise path required
The slug version of the enterprise name.
string
team_slug path required
The slug of the team name.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
enterpriseTeams.update
PATCH/enterprises/{enterprise}/teams/{team_slug}
To edit a team, the authenticated user must be an enterprise owner.

Parameters

required

The slug version of the enterprise name.

required

The slug of the team name.

Input

A new name for the team.

A new description for the team.

Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be changed.

Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). `all`: The team is assigned to all current and future organizations in the enterprise.

The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group.

The notification setting the team is set to. The options are: * `notifications_enabled` - team members receive notifications when the team is @mentioned. * `notifications_disabled` - no one receives notifications.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.enterpriseTeams.update({
  "sync_to_organizations": "disabled",
  "organization_selection_type": "disabled"
})