Конечные точки REST API для внешний участник совместной работы

Используйте REST API для управления внешний участник совместной работы.

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

Fine-grained access tokens for "List outside collaborators for an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Members" organization permissions (read)

Параметры для «List outside collaborators for an organization»

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Параметры запроса
Имя., Тип, Description
`filter` string Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without two-factor authentication enabled will be returned. `2fa_insecure` means that only outside collaborators with insecure 2FA methods will be returned. По умолчанию.: `all` Возможные значения: `2fa_disabled`, `2fa_insecure`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

HTTP response status codes for "List outside collaborators for an organization"

Status code	Description
`200`	OK

Code samples for "List outside collaborators for an organization"

Request example

get/orgs/{org}/outside_collaborators

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  http(s)://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://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
  }
]

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

Fine-grained access tokens for "Convert an organization member to outside collaborator"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Members" organization permissions (write)

Параметры для «Convert an organization member to outside collaborator»

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`username` string Обязательное поле The handle for the GitHub user account.

Параметры запроса
Имя., Тип, Description
`async` boolean When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. По умолчанию.: `false`

HTTP response status codes for "Convert an organization member to outside collaborator"

Status code	Description
`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

Code samples for "Convert an organization member to outside collaborator"

Request examples

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: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/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.

Fine-grained access tokens for "Remove outside collaborator from an organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Members" organization permissions (write)

Параметры для «Remove outside collaborator from an organization»

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.
`username` string Обязательное поле The handle for the GitHub user account.

HTTP response status codes for "Remove outside collaborator from an organization"

Status code	Description
`204`	No Content
`422`	Unprocessable Entity if user is a member of the organization

Code samples for "Remove outside collaborator from an organization"

Request example

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: 2026-03-10" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204