delete_end_user #
On this page
Generated automatically from the published contract sources.
A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/delete_end_user, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool tzcloud_delete_end_user.
OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).
Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.
Contract description #
Delete one of an application's end users: their identities, sessions, and passkeys with the user record. The realm's event log keeps its entries. Destructive: needs a credential with the destructive class (a signed-in session, or a token minted with destructive). The call creates a pending action, and the deletion runs only after a person approves it in the browser. An optional environment (development or production) chooses the realm you address. Without it, the call selects production. The development realm exists only once create_environment has turned development on.
More about this action #
Pass request_id to make a repeat safe. While the earlier pending action is still live (requested, approved, or executing), a call with the same request_id from the same account returns that action and creates no second one. Once the action has completed, failed, been declined, or expired, the same request_id starts a new one.
Access and action metadata #
{
"name": "delete_end_user",
"resource": "realm",
"tier": "destructive",
"surface": "tzcloud",
"addresses": [
"tzcloud"
],
"product": "cloud",
"summary": "Remove one end user's rows through the pending action, its description rendered from the platform's own record.",
"annotations": {
"readOnlyHint": false,
"destructiveHint": true,
"openWorldHint": false
}
}
MCP catalog entry #
{
"name": "delete_end_user",
"title": "Delete app user",
"tier": "destructive",
"summary": "Delete one of an application's end users: their identities, sessions, and passkeys with the user record. The realm's event log keeps its entries. Destructive: needs a credential with the destructive class (a signed-in session, or a token minted with `destructive`). The call creates a pending action, and the deletion runs only after a person approves it in the browser. An optional `environment` (`development` or `production`) chooses the realm you address. Without it, the call selects `production`. The development realm exists only once `create_environment` has turned development on.",
"owners": [
"ACS-L0-01",
"MAPI-05",
"PLD-L0-40"
],
"scenario": "ACS-L0-08"
}
request #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["application","end_user"] Additional properties: false |
| / |
Your account's application id from list_applications, not its name or label.Type: string |
| / |
The end user's opaque id, from list_end_users.Type: string |
| / |
Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one. Type: string |
| / |
Optional. The environment whose realm the call addresses, development or production; absent, production.Type: string Pattern: ^(development|production)$ |
response #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | The 202 creation envelope: the pending action and its approval link. Read the terminal outcome on the pending record with read_approval_status. Type: object Required fields: ["contract_version","pending_action","approval_url"] |
| / |
Required value: 1 |
| / |
The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call. Type: string Pattern: ^[0-9a-f]{10}$ |
| / |
$ref: #/shapes/pending_action |
| / |
Type: string |
| / |
Type: string |
Complete payload contract #
{
"request": {
"type": "object",
"required": [
"application",
"end_user"
],
"properties": {
"application": {
"type": "string",
"description": "Your account's application `id` from `list_applications`, not its name or label."
},
"end_user": {
"type": "string",
"description": "The end user's opaque id, from `list_end_users`."
},
"request_id": {
"type": "string",
"description": "Any string you choose. A repeat from the same account while that pending action is live returns it again, creating no second one. Omitted, every call creates a new one."
},
"environment": {
"type": "string",
"pattern": "^(development|production)$",
"description": "Optional. The environment whose realm the call addresses, `development` or `production`; absent, `production`."
}
},
"additionalProperties": false
},
"response": {
"type": "object",
"description": "The 202 creation envelope: the pending action and its approval link. Read the terminal outcome on the pending record with read_approval_status (API-L0-07).",
"required": [
"contract_version",
"pending_action",
"approval_url"
],
"properties": {
"contract_version": {
"const": 1
},
"reference": {
"type": "string",
"pattern": "^[0-9a-f]{10}$",
"description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call."
},
"pending_action": {
"$ref": "#/shapes/pending_action"
},
"approval_url": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
Shared contracts #
- Refusals: every refusal, by surface, with its cause and its remedy
- schemas/wire_error.schema.json
- schemas/wire_errors.json
- schemas/action_payloads.json (includes shared shapes)
- management_api_contract.md