Delete organization memberships

edit

Deletes one or more organization memberships. Currently unavailable in self-hosted ECE.

Request

edit

DELETE /api/v1/organizations/{organization_id}/members/{user_ids}

Path parameters

edit
Name Type Required Description

organization_id

string

Y

Identifier for the Organization

user_ids

string

Y

CSV list of User identifiers

Query parameters

edit
Name Type Required Description

force

boolean; default: false

N

Whether or not to force the removal of Org memberships (effective only for Platform Admins)

Responses

edit
200

(EmptyResponse)

Organization membership deleted successfully

404

(BasicFailedReply)

  • User not found. (code: user.not_found)
  • Organization not found. (code: organization.not_found)
  • Organization membership not found. (code: organization.membership_not_found)

Headers

x-cloud-error-codes (string; allowed values: [user.not_found, organization.not_found, organization.membership_not_found])
The error codes associated with the response

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/organizations/{organization_id}/members/{user_ids} \
-H "Authorization: ApiKey $ECE_API_KEY"