Skip to main content
REST API はバージョン管理になりました。 詳細については、「API のバージョン管理について」を参照してください。

外部コラボレーターの REST API エンドポイント

REST API を使って、外部コラボレーターを管理します。

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

"List outside collaborators for an organization" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには次のアクセス許可が設定されている必要があります:

  • members:read

"List outside collaborators for an organization" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
org string 必須

The organization name. The name is not case sensitive.

クエリ パラメーター
名前, Type, 説明
filter string

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

Default: all

次のいずれかにできます: 2fa_disabled, all

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default: 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>" \ -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."

"Convert an organization member to outside collaborator" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには次のアクセス許可が設定されている必要があります:

  • members:write

"Convert an organization member to outside collaborator" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
org string 必須

The organization name. The name is not case sensitive.

username string 必須

The handle for the GitHub user account.

本文のパラメーター
名前, Type, 説明
async boolean

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

Default: 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>" \ -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

Remove outside collaborator from an organization

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

"Remove outside collaborator from an organization" のきめ細かいアクセス トークン

このエンドポイントは、次のトークンの種類で動作します:

トークンには次のアクセス許可が設定されている必要があります:

  • members:write

"Remove outside collaborator from an organization" のパラメーター

ヘッダー
名前, Type, 説明
accept string

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

パス パラメーター
名前, Type, 説明
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>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204