DELETE/orgs/{org}/members/{username}

Remove an organization member

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

[!NOTE] If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

orgstringrequired

The organization name. The name is not case sensitive.

usernamestringrequired

The handle for the GitHub user account.

2 status codes

204Response

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.members.delete({
  org: "acme-inc",
  username: "octocat",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors