withdraw_test_end_users

Generated automatically from the published contract sources.

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.

A script calls this action over HTTPS at POST https://turnzero.ai/api/v1/actions/withdraw_test_end_users, with a bearer credential and the action's payload as the JSON body.

Contract description

End the admission of test end users on one of your application's production realm and remove every test end user it holds, as `delete_test_end_users` removes them. No approval is needed. A realm that does not admit them answers with nothing withdrawn and nothing removed. Works while the platform's `TEST_END_USERS` setting is off.

Access and action metadata

{
  "name": "withdraw_test_end_users",
  "resource": "realm",
  "tier": "reversible",
  "summary": "End the production realm's admission of test end users for one of the calling account's own applications, `application` alone, and remove every test end user of that realm as `delete_test_end_users` removes one, writing one info line to the control plane's stream naming the application and no address; admitted while `TEST_END_USERS` reads `off`, and a realm that does not admit them answers with nothing withdrawn and nothing removed.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "openWorldHint": false
  }
}

MCP catalog entry

{
  "name": "withdraw_test_end_users",
  "tier": "reversible",
  "summary": "End the admission of test end users on one of your application's production realm and remove every test end user it holds, as `delete_test_end_users` removes them. No approval is needed. A realm that does not admit them answers with nothing withdrawn and nothing removed. Works while the platform's `TEST_END_USERS` setting is off.",
  "owners": [
    "ACS-L0-21",
    "PLD-L0-40"
  ],
  "scenario": "ACS-L0-21"
}

request

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["application"]
Additional properties: false
/properties/application The application id, from `list_applications`; one of the calling account's own. The act names the application's production realm.

Type: string

response

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["contract_version","realm","application","withdrawn","removed"]
Additional properties: false
/properties/contract_version Required value: 1
/properties/realm The production realm's identifier, the application id.

Type: string
/properties/application Type: string
/properties/withdrawn True where an admission stood and was ended; false where the realm did not admit test end users.

Type: boolean
/properties/removed The identifiers of the production realm's test end users removed; empty where it held none.

Type: array
/properties/removed/items Type: string
/properties/detail Type: string

Complete payload contract

{
  "request": {
    "type": "object",
    "required": [
      "application"
    ],
    "properties": {
      "application": {
        "type": "string",
        "description": "The application id, from `list_applications`; one of the calling account's own. The act names the application's production realm."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "realm",
      "application",
      "withdrawn",
      "removed"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "realm": {
        "type": "string",
        "description": "The production realm's identifier, the application id."
      },
      "application": {
        "type": "string"
      },
      "withdrawn": {
        "type": "boolean",
        "description": "True where an admission stood and was ended; false where the realm did not admit test end users."
      },
      "removed": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The identifiers of the production realm's test end users removed; empty where it held none."
      },
      "detail": {
        "type": "string"
      }
    },
    "additionalProperties": false
  }
}

Shared contracts