Skip to content

Convert an organization member to outside collaborator

PUT
/orgs/{org}/outside_collaborators/{username}

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

API method documentation

org
required
string

The organization name. The name is not case sensitive.

username
required
string

The handle for the GitHub user account.

Media type application/json
object
async

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

boolean
Examples

Status code 202, asynchronous request

{
"async": true
}

User is getting converted asynchronously

Media type application/json
object
Examples
Example 202
null

User was converted

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

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated
{
"message": "example",
"documentation_url": "example",
"url": "example",
"status": "example"
}