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

Puntos de conexión de API REST para membresías de equipos empresariales

Usa la API de REST para crear y administrar la pertenencia de equipos empresariales en tu empresa de GitHub.

Acerca de los miembros del equipo empresarial

Nota:

Actualmente, estos puntos de conexión se encuentran en versión preliminar pública y están sujetos a cambios.

Esta documentación de la API está destinada a empresas en GitHub Enterprise Cloud.

Si tu empresa es Copilot Business para no GHE, consulta el vínculo de documentación de acceso anticipado que se te ha compartido anteriormente.

Estos puntos de conexión solo están disponibles para los miembros autenticados de la empresa del equipo empresarial con personal access tokens clásicos con el ámbito read:enterprise de las API GET y admin:enterprise para otras API.

Estos puntos de conexión no son compatibles con fine-grained personal access tokens o tokens de acceso a aplicaciones de GitHub.

GitHub genera el slug del equipo empresarial a partir del equipo name y agrega el prefijo ent:.

List members in an enterprise team

Lists all team members in an enterprise team.

Tokens de acceso granulares para "List members in an enterprise team"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise teams" enterprise permissions (read)

Parámetros para "List members in an enterprise team"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`enterprise` string Obligatorio The slug version of the enterprise name.
`enterprise-team` string Obligatorio The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Parámetros de consulta
Nombre, Tipo, Descripción
`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 The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "List members in an enterprise team"

código de estado	Descripción
`200`	OK

Ejemplos de código para "List members in an enterprise team"

Ejemplo de solicitud

get/enterprises/{enterprise}/teams/{enterprise-team}/memberships

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Bulk add team members

Add multiple team members to an enterprise team.

Tokens de acceso granulares para "Bulk add team members"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise teams" enterprise permissions (write)

Parámetros para "Bulk add team members"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`enterprise` string Obligatorio The slug version of the enterprise name.
`enterprise-team` string Obligatorio The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`usernames` array of strings Obligatorio The GitHub user handles to add to the team.

Códigos de estado de respuesta HTTP para "Bulk add team members"

código de estado	Descripción
`200`	Successfully added team members.

Ejemplos de código para "Bulk add team members"

Ejemplo de solicitud

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/add \
  -d '{"usernames":["monalisa","octocat"]}'

Successfully added team members.

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Bulk remove team members

Remove multiple team members from an enterprise team.

Tokens de acceso granulares para "Bulk remove team members"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise teams" enterprise permissions (write)

Parámetros para "Bulk remove team members"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`enterprise` string Obligatorio The slug version of the enterprise name.
`enterprise-team` string Obligatorio The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`usernames` array of strings Obligatorio The GitHub user handles to be removed from the team.

Códigos de estado de respuesta HTTP para "Bulk remove team members"

código de estado	Descripción
`200`	Successfully removed team members.

Ejemplos de código para "Bulk remove team members"

Ejemplo de solicitud

post/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/remove \
  -d '{"usernames":["monalisa","octocat"]}'

Successfully removed team members.

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Add team member

Add a team member to an enterprise team.

Tokens de acceso granulares para "Add team member"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise teams" enterprise permissions (write)

Parámetros para "Add team member"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`enterprise` string Obligatorio The slug version of the enterprise name.
`enterprise-team` string Obligatorio The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
`username` string Obligatorio The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Add team member"

código de estado	Descripción
`201`	Successfully added team member

Ejemplos de código para "Add team member"

Ejemplo de solicitud

put/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Successfully added team member

Status: 201

{
  "login": "octocat",
  "id": 1,
  "node_id": "MDQ6VXNlcjE=",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://HOSTNAME/users/octocat",
  "html_url": "https://github.com/octocat",
  "followers_url": "https://HOSTNAME/users/octocat/followers",
  "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
  "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
  "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
  "organizations_url": "https://HOSTNAME/users/octocat/orgs",
  "repos_url": "https://HOSTNAME/users/octocat/repos",
  "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
  "received_events_url": "https://HOSTNAME/users/octocat/received_events",
  "type": "User",
  "site_admin": false
}

Remove team membership

Remove membership of a specific user from a particular team in an enterprise.

Tokens de acceso granulares para "Remove team membership"

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

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise teams" enterprise permissions (write)

Parámetros para "Remove team membership"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`enterprise` string Obligatorio The slug version of the enterprise name.
`enterprise-team` string Obligatorio The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
`username` string Obligatorio The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Remove team membership"

código de estado	Descripción
`204`	No Content
`403`	Forbidden

Ejemplos de código para "Remove team membership"

Ejemplo de solicitud

delete/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/teams/ENTERPRISE-TEAM/memberships/USERNAME

Response

Status: 204