Puntos de conexión de API REST para colaboradores externos

Note

Si la empresa utiliza cuentas de usuario administradas, el rol de colaborador externo se denomina "colaborador del repositorio". Por lo general, la documentación de colaboradores externos también se aplica a los colaboradores del repositorio. Para conocer las distinciones que se aplican, vea "Roles en una organización".

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

Tokens de acceso específicos para "List outside collaborators for 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 (read)

Parámetros para "List outside collaborators for an organization"

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Parámetros de consulta
Nombre, Tipo, Descripción
`filter` string Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without two-factor authentication enabled will be returned. Valor predeterminado: `all` Puede ser uno de los siguientes: `2fa_disabled`, `all`
`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 outside collaborators for an organization"

status code	Descripción
`200`	OK

Ejemplos de código para "List outside collaborators for an organization"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/orgs/{org}/outside_collaborators

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

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."

Tokens de acceso específicos para "Convert an organization member to outside collaborator"

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 "Convert an organization member to outside collaborator"

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`username` string Requerido The handle for the GitHub user account.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`async` boolean When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. Valor predeterminado: `false`

Códigos de estado de respuesta HTTP para "Convert an organization member to outside collaborator"

status code	Descripció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 para "Convert an organization member to outside collaborator"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplos de solicitud

Select the example type

put/orgs/{org}/outside_collaborators/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME \
  -d '{"async":true}'

User is getting converted asynchronously

Status: 202

Remove outside collaborator from an organization

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

Tokens de acceso específicos para "Remove outside collaborator from 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 "Remove outside collaborator from an organization"

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

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`username` string Requerido The handle for the GitHub user account.

Códigos de estado de respuesta HTTP para "Remove outside collaborator from an organization"

status code	Descripción
`204`	No Content
`422`	Unprocessable Entity if user is a member of the organization

Ejemplos de código para "Remove outside collaborator from an organization"

If you access GitHub at GHE.com, replace api.github.com with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/orgs/{org}/outside_collaborators/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204