Remove a user from a registry
Takes a user’s access to one registry away when they leave it or are deactivated on your side. Their access ends on their next request; an open session does not keep working until it expires.
One registry at a time. For a user in several registries, this
removes only the registry named by organization_ref; they keep the
others. When it removes their last registry, the account is
deactivated.
Reversible. The account is kept as it is (email, your user ID,
workspace). To give the user that registry back, send them again with
PUT /users for it: you get the same account back (200,
created: false).
Idempotent: deactivating a user who is already deactivated also
returns 204, so your sync can replay it freely.
The user is identified within the registry named by
organization_ref, using that registry’s auth server, the same way
PUT /users identifies them. It never affects a user in another
registry.
Authentication
Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.
Path parameters
Your user ID (the external_user_ref you sent to PUT /users). Must not be blank.
Query parameters
The registry the user belongs to (its external_ref).
Response
Removed from the registry (or already removed).