Skip to content

Commit 6951ad5

Browse files
authored
External groups REST API documentation
1 parent 30151e9 commit 6951ad5

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

content/rest/reference/teams.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,28 @@ This API is only available to authenticated members of the team's organization.
5252
{% if operation.subcategory == 'members' %}{% include rest_operation %}{% endif %}
5353
{% endfor %}
5454

55+
{% ifversion ghec %}
56+
## External groups
57+
58+
The external groups API allows you to view the external identity provider groups that are available to your organization and manage the connection between external groups and teams in your organization.
59+
60+
To use this API, the authenticated user must be a team maintainer or an owner of the organization associated with the team.
61+
62+
{% note %}
63+
64+
**Notes:**
65+
66+
- The external groups API is only available for organizations that are part of a enterprise using {% data variables.product.prodname_emus %}. For more information, see "[About Enterprise Managed Users](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)."
67+
- If your organization uses team synchronization, you can use the Team Synchronization API. For more information, see "[Team synchronization API](#team-synchronization)."
68+
69+
{% endnote %}
70+
71+
{% for operation in currentRestOperations %}
72+
{% if operation.subcategory == 'external-groups' %}{% include rest_operation %}{% endif %}
73+
{% endfor %}
74+
75+
{% endif %}
76+
5577
{% ifversion fpt or ghes or ghec %}
5678
## Team synchronization
5779

@@ -61,7 +83,7 @@ You can manage GitHub team members through your IdP with team synchronization. T
6183

6284
{% note %}
6385

64-
**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}.
86+
**Note:** The Team Synchronization API cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.product.prodname_emu_org %}, see "[External groups API](/enterprise-cloud@latest/rest/reference/teams#external-groups)".
6587

6688
{% endnote %}
6789

0 commit comments

Comments
 (0)