Pontos de extremidade de API REST para colaboradores externos

Note

Se sua empresa usa contas de usuário gerenciadas, a função de colaborador externo será chamada de "colaborador do repositório". Geralmente, a documentação para colaboradores externos também se aplica a colaboradores do repositório. Para as distinções que se aplicam, consulte "Funções em uma organização".

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

Tokens de acesso refinados para "List outside collaborators for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Members" organization permissions (read)

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

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`filter` string Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without two-factor authentication enabled will be returned. Padrão: `all` Pode ser um dos: `2fa_disabled`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "List outside collaborators for an organization"

Código de status	Descrição
`200`	OK

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

Exemplo de solicitação

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

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Members" organization permissions (write)

Parâmetros para "Convert an organization member to outside collaborator"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`username` string Obrigatório The handle for the GitHub user account.

Parâmetros do corpo
Nome, Tipo, Descrição
`async` boolean When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. Padrão: `false`

Códigos de status de resposta HTTP para "Convert an organization member to outside collaborator"

Código de status	Descrição
`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

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

Exemplos de solicitação

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 acesso refinados para "Remove outside collaborator from an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Members" organization permissions (write)

Parâmetros para "Remove outside collaborator from an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`username` string Obrigatório The handle for the GitHub user account.

Códigos de status de resposta HTTP para "Remove outside collaborator from an organization"

Código de status	Descrição
`204`	No Content
`422`	Unprocessable Entity if user is a member of the organization

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

Exemplo de solicitação

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