外部协作者 - GitHub AE Docs

使用 REST API 管理外部协作者。

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

“List outside collaborators for an organization”的参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org`string必选 The organization name. The name is not case sensitive.
查询参数
名称, 类型, 说明
`filter`string Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without two-factor authentication enabled will be returned. 默认: `all` 可以是以下选项之一: `2fa_disabled`, `all`
`per_page`integer The number of results per page (max 100). 默认: `30`
`page`integer Page number of the results to fetch. 默认: `1`

“List outside collaborators for an organization”的 HTTP 响应状态代码

状态代码	说明
`200`	OK

“List outside collaborators for an organization”的示例代码

get/orgs/{org}/outside_collaborators

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

适用于 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."

“Convert an organization member to outside collaborator”的参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org`string必选 The organization name. The name is not case sensitive.
`username`string必选 The handle for the GitHub user account.
正文参数
名称, 类型, 说明
`async`boolean When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. 默认: `false`

“Convert an organization member to outside collaborator”的 HTTP 响应状态代码

状态代码	说明
`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

“Convert an organization member to outside collaborator”的示例代码

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

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

适用于 GitHub Apps

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

“Remove outside collaborator from an organization”的参数

标头
名称, 类型, 说明
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 说明
`org`string必选 The organization name. The name is not case sensitive.
`username`string必选 The handle for the GitHub user account.

“Remove outside collaborator from an organization”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`422`	Unprocessable Entity if user is a member of the organization

“Remove outside collaborator from an organization”的示例代码

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204