enterprise-teams

Create an enterprise team

Changed on

To create an enterprise team, the authenticated user must be an owner of the enterprise.

post/enterprises/{enterprise}/teams

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/teams
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Request body

namestring required

The name of the team.

descriptionstring nullable

A description of the team.

sync_to_organizations'all' | 'disabled'

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

organization_selection_type'disabled' | 'selected' | 'all'

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 endpoint. all: The team is assigned to all current and future organizations in the enterprise.

group_idstring nullable

The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

notification_setting'notifications_enabled' | 'notifications_disabled'

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.

Default: notifications_enabled

Response

Response

idinteger required
namestring required
descriptionstring
slugstring required
urlstring uri required
sync_to_organizationsstring

Retired: this field will not be returned with GHEC enterprise teams.

organization_selection_typestring
group_idstring nullable required
group_namestring nullable

Retired: this field will not be returned with GHEC enterprise teams.

html_urlstring uri required
members_urlstring required
created_atstring date-time required
updated_atstring date-time required
notification_setting'notifications_enabled' | 'notifications_disabled'

Whether team members will receive notifications when the team is mentioned.

Example response

{
  "sync_to_organizations": "disabled | all",
  "organization_selection_type": "disabled | selected | all",
  "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
  "group_name": "Justice League",
  "html_url": "https://github.com/enterprises/dc/teams/justice-league",
  "notification_setting": "notifications_enabled"
}

Changes

  • 2022-11-280f10eea637deRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status