foliot docs

API reference / Platform / Take a person off the platform

Take a person off the platform

DELETE/platform/operators/{userId}

Authenticate with a signed-in Foliot Console session.

Ends the person’s platform role on their very next request. Their Clerk account and every workspace membership they hold are untouched. A signed-in person who holds a platform role (Tin Bee’s staff), read from Foliot’s own table on every request. Everyone else, an operator token and an app key included, is answered 404, the same bytes for all of them. A platform owner; a platform operator is 403. 404 if they hold no platform role. 409 if they are the platform’s only owner: make someone else a platform owner first. Recorded in the platform’s history.

Path parameters

userId
string (uuid)
REQUIRED

Foliot's id for the person (userId in the operators list), not their Clerk id.

Responses

204 no body No Content
400 Error Invalid request.
401 Error Missing, malformed or unknown bearer token.
403 Error The token is valid but not permitted on this route.
404 Error No such resource.
409 Error Conflicts with existing state.
503 Error A dependency this route needs is unreachable.