Turn a seat on or off, or change a role

Needs an organization admin or an organization API key with Admin access, and an active paid subscription. It never buys seats. Turning a seat off does not remove access to cubic. To remove someone, remove them from the GitHub organization.

patch/api/v1/organizations/{org}/members/{githubUserId}

Request

  • Base URL: https://www.cubic.dev
  • URL: https://www.cubic.dev/api/v1/organizations/{org}/members/{githubUserId}
  • Auth: HTTP bearer

Path parameters

orgstring required

GitHub organization login, such as acme.

githubUserIdstring required

Numeric GitHub user ID of the member.

Request body

seatboolean

Desired seat state. Send with expectedSeat.

role'member' | 'admin' | 'viewer'

Desired role. Send with expectedRole.

expectedSeatboolean

Current seat state from your latest read; send only with seat.

expectedRole'member' | 'admin' | 'viewer'

Current role from your latest read; send only with role.

Response

OK

githubUserIdstring required
changedboolean required
availableSeatsnumber required
purchasedQuantityChangedfalse required

Changes

No recorded changes to this operation across all 1 revision of this API.