Colaboradores

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda la documentación de GitHub es de código abierto. ¿Ve algo incorrecto o que no esté claro? Envíe una solicitud de incorporación de cambios.

¡Ayúdanos a hacer geniales estos documentos!

Ayuda para cualquier punto de su recorrido por GitHub.

Consulta el vídeo de esta transcripción.

Puede ser uno de los siguientes

Nombre

Parámetros del cuerpo de la solicitud de webhook

Todas las guías de {{ name }}

Rutas de aprendizaje de {{ name }}

Acciones

GitHub comenzó a implementar estos cambios en empresas en

Introduzca un término de búsqueda para encontrarlo en la documentación de GitHub.

Colaboradores - GitHub AE Docs

La API de REST permite agregar, invitar y eliminar colaboradores de un repositorio.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Inicio rápido

Acerca de las API de GitHub

Recursos en la API de REST

Tipos de medios

Autenticación

Protección de las credenciales de API

Solución de problemas

Bibliotecas

Tipos de eventos de los informes de problemas

Tipos de evento de GitHub

Puntos de conexión para tokens de instalación de aplicaciones de GitHub

Puntos de conexión para tokens de usuario de aplicaciones de GitHub

Permisos para instancias de GitHub App

Información general

Uso de la API

Script con JavaScript

Descubrimiento de recursos para un usuario

Entregar despliegues

Representar los datos en gráficas

Trabajar con los comentarios

Paginación

Crear un servidor de IC

procedimientos recomendados

Introducción: base de datos de Git

Introducción: Comprobaciones

Cifrado de secretos

Guías

Artifacts

Permisos

Secretos

Grupos de ejecutores auto-hospedados

Ejecutores autohospedados

Jobs de los flujos de trabajo

Ejecuciones de flujo de trabajo

Workflows

Eventos

Fuentes

Notificaciones

Marcar con una estrella

Observando

Actividad

Aplicaciones de GitHub

Instalaciones

Autorizaciones de OAuth

webhooks

Aplicaciones

Ramas

Ramas protegidas

Ejecuciones de Verificación

Conjuntos de Verificaciones

Comprobaciones

Códigos de conducta

Examen del código

Invitaciones

Confirmaciones

Comentarios sobre confirmación de cambios

Estados de confirmación

Claves de implementación

Directivas de rama de implementación

Implementaciones

Entornos

Estados de despliegue

Emojis

Estadísticas de los Administradores

Anuncio

Registro de auditoría

Webhooks globales

Licencia

Las organizaciones

Ambientes de pre-recepción

Usuarios

Administración empresarial

Gists

Comentarios

Datos BLOB

Referencias

Etiquetas

Árboles

Base de datos de Git

Gitignore

Incidencias

Asignados

Hitos

Escala de tiempo

Licencias

Markdown

Estadísticas

Métricas

Migraciones

Miembros

Colaboradores externos

Páginas

Boards

Cards

Columnas

Project boards

Extracciones

Revisar comentarios

Solicitudes de revisión

Revisiones

Límite de frecuencia

Reacciones

Versiones

Recursos de versión

Vínculos automáticos

Contenido

Horquillas

Git LFS

Repositorios

Search

Análisis de secretos

Teams

Comentarios de debate

Debates

Grupos externos

Seguidores

Claves GPG

Claves SSH de Git

Configuración del webhook del repositorio

Entregas de webhook de repositorio

Webhooks de repositorio

API DE REST

Collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Filter collaborators returned by their affiliation. <code>outside</code> means all outside collaborators of an organization-owned repository. <code>direct</code> means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. <code>all</code> means all collaborators the authenticated user can see.

affiliation

Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.

permission

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List repository collaborators

Response if user is a collaborator

For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Team members will include the members of child teams.
You must authenticate using an access token with the <code>read:org</code> and <code>repo</code> scopes with push access to use this
endpoint. GitHub Apps must have the <code>members</code> organization permission and <code>metadata</code> repository permission to use this
endpoint.

The handle for the GitHub user account.

username

Not Found if user is not a collaborator

Check if a user is a repository collaborator

The permission to grant the collaborator. Only valid on organization-owned repositories.

Add a collaborator with triage permissions

Response when:
<ul>
<li>an existing collaborator is added as a collaborator</li>
<li>an organization member is added as an individual collaborator</li>
<li>an existing team member (whose team is also a repository collaborator) is added as an individual collaborator</li>
</ul>

This endpoint triggers <a href="https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits">Secondary rate limits</a>" and "<a href="https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits">Dealing with secondary rate limits</a>" for details.
Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "<a href="https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories">Enforcing repository management policies in your enterprise</a>."
For more information on permission levels, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization">Repository permission levels for an organization</a>". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
<pre><code>Cannot assign {member} permission of {role name}
</code></pre>
Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs">HTTP verbs</a>."
Updating an existing collaborator's permission level
The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.

Validation failed, or the endpoint has been spammed.

Add a repository collaborator

No Content when collaborator was removed from the repository.

Removes a collaborator from a repository.
To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
This endpoint also:
<ul>
<li>Cancels any outstanding invitations</li>
<li>Unasigns the user from any issues</li>
<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>
<li>Unstars the repository</li>
<li>Updates access permissions to packages</li>
</ul>
Removing a user as a collaborator has the following effects on forks:
<ul>
<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>
<li>If the user had their own fork of the repository, the fork will be deleted.</li>
<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>
</ul>
Note: A user can still have access to the repository through organization permissions like base repository permissions.
Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.
For more information on fork permissions, see "<a href="https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks">About permissions and visibility of forks</a>".

Remove a repository collaborator

Repository Collaborator Permission

Checks the repository permission of a collaborator. The possible repository
permissions are <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>.
Note: The <code>permission</code> attribute provides the legacy base roles of <code>admin</code>, <code>write</code>, <code>read</code>, and <code>none</code>, where the
<code>maintain</code> role is mapped to <code>write</code> and the <code>triage</code> role is mapped to <code>read</code>. To determine the role assigned to the
collaborator, see the <code>role_name</code> attribute, which will provide the full role name, including custom roles. The
<code>permissions</code> hash can also be used to determine which base level of access the collaborator has to the repository.