Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para grupos externos

Para utilizar estos puntos de conexión, el usuario autenticado debe ser un mantenedor del equipo o un propietario de la organización asociada con este.

Nota:

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 Enterprise Cloud. For more information, see "'s products" in the Help documentation.

Tokens de acceso específicos para "Get an external group"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Members" organization permissions (write)

Parámetros para "Get an external group"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
org string Requerido

The organization name. The name is not case sensitive.

group_id integer Requerido

The unique identifier of the group.

Parámetros de consulta
per_page integer

The number of results per page for the "members" array (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the "members" array results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "Get an external group"

status codeDescripción
200

OK

Ejemplos de código para "Get an external group"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/orgs/{org}/external-group/{group_id}
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..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": "[email protected]" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "[email protected]" } ] }

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. Enterprise Cloud 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 Enterprise Cloud. For more information, see "'s products" in the Help documentation.

Tokens de acceso específicos para "List external groups in an organization"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Members" organization permissions (write)

Parámetros para "List external groups in an organization"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
org string Requerido

The organization name. The name is not case sensitive.

Parámetros de consulta
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

Page token

display_name string

Limits the list to groups containing the text in the group name

Códigos de estado de respuesta HTTP para "List external groups in an organization"

status codeDescripción
200

OK

Ejemplos de código para "List external groups in an organization"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/orgs/{org}/external-groups
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..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" } ] }

Lists a connection between a team and an external group.

You can manage team membership with your identity provider using Enterprise Managed Users for Enterprise Cloud. For more information, see "'s products" in the Help documentation.

Tokens de acceso específicos para "List a connection between an external group and a team"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Members" organization permissions (write)

Parámetros para "List a connection between an external group and a team"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
org string Requerido

The organization name. The name is not case sensitive.

team_slug string Requerido

The slug of the team name.

Códigos de estado de respuesta HTTP para "List a connection between an external group and a team"

status codeDescripción
200

OK

Ejemplos de código para "List a connection between an external group and a team"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/orgs/{org}/teams/{team_slug}/external-groups
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..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" } ] }

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 Enterprise Cloud. For more information, see "'s products" in the Help documentation.

Tokens de acceso específicos para "Update the connection between an external group and a team"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Members" organization permissions (write)

Parámetros para "Update the connection between an external group and a team"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
org string Requerido

The organization name. The name is not case sensitive.

team_slug string Requerido

The slug of the team name.

Parámetros del cuerpo
group_id integer Requerido

External Group Id

Códigos de estado de respuesta HTTP para "Update the connection between an external group and a team"

status codeDescripción
200

OK

Ejemplos de código para "Update the connection between an external group and a team"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

/orgs/{org}/teams/{team_slug}/external-groups
curl -L \ -X \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..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": "[email protected]" }, { "member_id": 2, "member_login": "octo-lisa_eocsaxrs", "member_name": "Octo Lisa", "member_email": "[email protected]" } ] }

Deletes a connection between a team and an external group.

You can manage team membership with your IdP using Enterprise Managed Users for Enterprise Cloud. For more information, see 's products in the Help documentation.

Tokens de acceso específicos para "Remove the connection between an external group and a team"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Members" organization permissions (write)

Parámetros para "Remove the connection between an external group and a team"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
org string Requerido

The organization name. The name is not case sensitive.

team_slug string Requerido

The slug of the team name.

Códigos de estado de respuesta HTTP para "Remove the connection between an external group and a team"

status codeDescripción
204

No Content

Ejemplos de código para "Remove the connection between an external group and a team"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/orgs/{org}/teams/{team_slug}/external-groups
curl -L \ -X DELETE \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/teams/TEAM_SLUG/external-groups

Response

Status: 204