Skip to main content
Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.
GitHub AE está actualmente en un lanzamiento limitado. Por favor, contacta a nuestro equipo de ventas para conocer más sobre esto.

Outside Collaborators

List outside collaborators for an organization

Funciona con GitHub Apps

List all users who are outside collaborators of an organization.

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
filterstring

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned.

Predeterminado: all

Puede ser una de las siguientes: 2fa_disabled, all

per_pageinteger

The number of results per page (max 100).

Predeterminado: 30

pageinteger

Page number of the results to fetch.

Predeterminado: 1

Códigos de estado de respuesta HTTP

Código de estadoDescripción
200

OK

Ejemplos de código

get/orgs/{org}/outside_collaborators
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/outside_collaborators

Response

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

Convert an organization member to outside collaborator

Funciona con GitHub Apps

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "Enforcing repository management policies in your enterprise."

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

usernamestringRequerido

The handle for the GitHub user account.

Parámetros de cuerpo
Nombre, Tipo, Descripción
asyncboolean

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

Predeterminado: false

Códigos de estado de respuesta HTTP

Código de estadoDescripción
202

User is getting converted asynchronously

204

User was converted

403

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "Enforcing repository management policies in your enterprise."

404

Resource not found

Ejemplos de código

put/orgs/{org}/outside_collaborators/{username}
curl \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/outside_collaborators/USERNAME \ -d '{"async":true}'

User is getting converted asynchronously

Status: 202

Remove outside collaborator from an organization

Funciona con GitHub Apps

Removing a user from this list will remove them from all the organization's repositories.

Parámetros

Encabezados
Nombre, Tipo, Descripción
acceptstring

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
orgstringRequerido

The organization name. The name is not case sensitive.

usernamestringRequerido

The handle for the GitHub user account.

Códigos de estado de respuesta HTTP

Código de estadoDescripción
204

No Content

422

Unprocessable Entity if user is a member of the organization

Ejemplos de código

delete/orgs/{org}/outside_collaborators/{username}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://HOSTNAME/api/v3/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204