Remove a team member

delete

https://api.qfp.quantnetwork.net/api/tenants/{id}/users/{userId}

A soft delete: access is revoked and the row is kept with REMOVED
status.

Checks, in order:

The path tenant equals the caller's tenant_id claim (403).
The caller resolves and is ACTIVE (401).
The caller holds member:remove (403).
The target is not the caller (400 You cannot remove yourself.).
The target exists within that tenant (404 User not found).
The target is not the tenant's owner (400 The tenant owner cannot be removed.).

The Cognito account is disabled and globally signed out before the
status is written, so the user cannot sign in again. An account
absent from the pool does not fail the removal; any other Cognito
failure is 500 and leaves the row untouched. Repeating the call
re-runs the revocation and returns the member unchanged.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The removed member, status REMOVED.

400The caller is removing themselves, the target is the tenant owner, or a path id is not a UUID.

401No usable token, or the caller's own status is not ACTIVE (Your access has been revoked.).

403The path tenant is not the caller's own (Invalid tenant id), or the caller does not hold member:remove (You do not have permission to remove team members.).

404No user with this id in this tenant (User not found).

500Cognito access could not be revoked: Failed to revoke access for user '{email}'.