外部组 - GitHub Docs

外部组

外部组 API 允许您查看可用于组织的外部标识提供者组，并管理组织中外部组和团队之间的连接。

关于外部组 API

要使用此 API，经过身份验证的用户必须是团队维护员或与团队关联的组织的所有者。

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.

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`group_id`integer必选 The unique identifier of the group.

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

get/orgs/{org}/external-group/{group_id}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/external-group/GROUP_ID

Response

Status: 200

{
  "group_id": "123",
  "group_name": "Octocat admins",
  "updated_at": "2021-01-24T11:31:04-06:00",
  "teams": [
    {
      "team_id": 1,
      "team_name": "team-test"
    },
    {
      "team_id": 2,
      "team_name": "team-test2"
    }
  ],
  "members": [
    {
      "member_id": 1,
      "member_login": "mona-lisa_eocsaxrs",
      "member_name": "Mona Lisa",
      "member_email": "mona_lisa@github.com"
    },
    {
      "member_id": 2,
      "member_login": "octo-lisa_eocsaxrs",
      "member_name": "Octo Lisa",
      "member_email": "octo_lisa@github.com"
    }
  ]
}

List external groups in an organization

使用 GitHub Apps

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.

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
查询参数
名称, 类型, 描述
`per_page`integer The number of results per page (max 100). 默认值: `30`
`page`integer Page token
`display_name`string Limits the list to groups containing the text in the group name

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

get/orgs/{org}/external-groups

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/external-groups

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "updated_at": "2021-01-24T11:31:04-06:00"
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "updated_at": "2021-03-24T11:31:04-06:00"
    }
  ]
}

List a connection between an external group and a team

使用 GitHub Apps

Lists a connection between a team and an external group.

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.

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`team_slug`string必选 The slug of the team name.

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

get/orgs/{org}/teams/{team_slug}/external-groups

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "updated_at": "2021-01-24T11:31:04-06:00"
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "updated_at": "2021-03-24T11:31:04-06:00"
    }
  ]
}

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.

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`team_slug`string必选 The slug of the team name.
正文参数
名称, 类型, 描述
`group_id`integer必选 External Group Id

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

patch/orgs/{org}/teams/{team_slug}/external-groups

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups \
  -d '{"group_id":123}'

Response

Status: 200

{
  "group_id": "123",
  "group_name": "Octocat admins",
  "updated_at": "2021-01-24T11:31:04-06:00",
  "teams": [
    {
      "team_id": 1,
      "team_name": "team-test"
    },
    {
      "team_id": 2,
      "team_name": "team-test2"
    }
  ],
  "members": [
    {
      "member_id": 1,
      "member_login": "mona-lisa_eocsaxrs",
      "member_name": "Mona Lisa",
      "member_email": "mona_lisa@github.com"
    },
    {
      "member_id": 2,
      "member_login": "octo-lisa_eocsaxrs",
      "member_name": "Octo Lisa",
      "member_email": "octo_lisa@github.com"
    }
  ]
}

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.

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
路径参数
名称, 类型, 描述
`org`string必选 The organization name. The name is not case sensitive.
`team_slug`string必选 The slug of the team name.

HTTP 响应状态代码

状态代码	描述
`204`	No Content

代码示例

delete/orgs/{org}/teams/{team_slug}/external-groups

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/external-groups

Response

Status: 204