Remove a collaborator from a Copilot Space for a user

4 parameters

usernamestringrequired

The handle for the GitHub user account.

space_numberintegerrequired

The unique identifier of the Copilot Space.

actor_typestringrequired

The type of actor (must be `User` for user-owned spaces; `Team` will be rejected).

Allowed:UserTeam

actor_identifierstringrequired

The username of the collaborator. The numeric user ID is also accepted.

3 status codes

204Response

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "octri-github";

const client = new Client({
  baseUrl: "https://api.github.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.collaborators.delete({
  username: "octocat",
  spaceNumber: "example",
  actorType: "example",
  actorIdentifier: "example",
});

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

Was this helpful?

Request

Response

Errors