Delete organization memberships

DELETE /organizations/{organization_id}/members/{user_ids}
Basic auth Api key

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

Path parameters

  • organization_id string Required

    Identifier for the Organization

  • user_ids string Required

    CSV list of User identifiers

Query parameters

  • force boolean

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

    Default value is false.

Responses

  • 200 application/json

    Organization membership deleted successfully
  • 404 application/json
    • User not found. (code: user.not_found)
    • Organization not found. (code: organization.not_found)
    • Organization membership not found. (code: organization.membership_not_found)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are user.not_found, organization.not_found, or organization.membership_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /organizations/{organization_id}/members/{user_ids} 
curl \
 --request DELETE 'https://{{hostname}}/api/v1/organizations/{organization_id}/members/{user_ids}' \
 --user "username:password"