A newer version is available. For the latest information, see the
current release documentation.
Delete organization membershipsedit
Deletes one or more organization memberships. Currently unavailable in self-hosted ECE.
Requestedit
DELETE /api/v1/organizations/{organization_id}/members/{user_ids}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Organization |
|
|
Y |
CSV list of User identifiers |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Whether or not to force the removal of Org memberships (effective only for Platform Admins) |
Responsesedit
-
200
-
Organization membership deleted successfully
-
404
-
-
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
-
User not found. (code:
Request exampleedit
curl -XDELETE https://{{hostname}}/api/v1/organizations/{organization_id}/members/{user_ids} \ -H "Authorization: ApiKey $ECE_API_KEY"