Remove a Member

DELETE /v1/members/{member_id}

Removes the Member at the revision If-Match names and answers a MemberRemoval (1.51.0, FR-identity-5). The removal ends the Member's sessions at once, in its transaction: a console session answers 401 unauthenticated from its next request, and a Member ID token is refused from its next request as an identity with no Member, so its next sign-in waits for approval as a sign-in attempt. The Member's id stays in the Audit events, its email may be invited again, and a second removal answers not_found. A Member may remove itself. The Audit event identity.member.remove records the Member id and its role and status, never the email. From 1.51.0 a write that would leave the Organization without an owner (removing the only owner, demoting it to another role or disabling it) is refused with last_owner and one detail whose reason is a LastOwnerChange, and changes nothing. That rule is checked first; then a caller that is not an owner and removes, demotes or disables an owner is refused with forbidden and the detail owner_required, because only an owner changes an owner. Phase 0 accepts a Member ID token for this route, so an operator signed in to the cockpit makes the write.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the members:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X DELETE "$VOCAL_API/v1/members/mem_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

const response = await fetch(`${process.env.VOCAL_API}/v1/members/mem_...`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.delete(
    f"{os.environ['VOCAL_API']}/v1/members/mem_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is MemberRemoval.