revoke_app_sign_in_keys #

View this page as Markdown

On this page

Generated automatically from the published contract sources.

A script calls this action over HTTPS at POST https://tzcloud.turnzero.ai/v1/revoke_app_sign_in_keys, with a bearer credential and the action's payload as the JSON body. An MCP connection lists this action as the tool tzcloud_revoke_app_sign_in_keys.

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 #

Revoke every signing key of one of an application's sign-in realms, for a suspected key compromise. Every end-user session token the keys signed is refused as key_revoked on every serving router within sixty seconds. Every user of the realm signs in again, and the platform creates the replacement key at the realm's next sign-in. You must pass environment: development or production, the realm whose keys are revoked. You get back the revoked key identifiers and the key set's new version.

Access and action metadata #

{
  "name": "revoke_app_sign_in_keys",
  "resource": "realm",
  "tier": "reversible",
  "surface": "tzcloud",
  "addresses": [
    "tzcloud"
  ],
  "product": "cloud",
  "summary": "Revoke every signing key of one realm: every session token the keys signed is refused as key_revoked once the routers sync, every user signs in again, and the accounts service mints the replacement at the next sign-in.",
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": true,
    "openWorldHint": false
  }
}

MCP catalog entry #

{
  "name": "revoke_app_sign_in_keys",
  "title": "Revoke app sign-in keys",
  "tier": "reversible",
  "summary": "Revoke every signing key of one of an application's sign-in realms, for a suspected key compromise. Every end-user session token the keys signed is refused as `key_revoked` on every serving router within sixty seconds. Every user of the realm signs in again, and the platform creates the replacement key at the realm's next sign-in. You must pass `environment`: `development` or `production`, the realm whose keys are revoked. You get back the revoked key identifiers and the key set's new version.",
  "owners": [
    "ACS-L0-08",
    "PLD-L0-40"
  ],
  "scenario": "ACS-L0-08"
}

request #

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["application","environment"]
Additional properties: false
/properties/application Your account's application id from list_applications, not its name or label.

Type: string
/properties/environment Required. The environment whose realm's signing keys you revoke, development or production.

Type: string
Pattern: ^(development|production)$

response #

JSON pointer Description and constraints
"" (root) Type: object
Required fields: ["contract_version","realm","application","environment","revoked","keys_changed_at"]
Additional properties: false
/properties/contract_version Required value: 1
/properties/realm The realm identifier: the application id for production, <id>:development for development.

Type: string
/properties/application Type: string
/properties/environment Type: string
Pattern: ^(development|production)$
/properties/revoked The key identifiers stamped revoked by this call; empty where the realm held no live key.

Type: array
/properties/revoked/items Type: string
/properties/keys_changed_at The realm key set's version after the call, the value the sync route and the key-set route return as version.

Type: ["string","null"]
/properties/detail Type: string

Complete payload contract #

{
  "request": {
    "type": "object",
    "required": [
      "application",
      "environment"
    ],
    "properties": {
      "application": {
        "type": "string",
        "description": "Your account's application `id` from `list_applications`, not its name or label."
      },
      "environment": {
        "type": "string",
        "pattern": "^(development|production)$",
        "description": "Required. The environment whose realm's signing keys you revoke, `development` or `production`."
      }
    },
    "additionalProperties": false
  },
  "response": {
    "type": "object",
    "required": [
      "contract_version",
      "realm",
      "application",
      "environment",
      "revoked",
      "keys_changed_at"
    ],
    "properties": {
      "contract_version": {
        "const": 1
      },
      "realm": {
        "type": "string",
        "description": "The realm identifier: the application id for production, `<id>:development` for development."
      },
      "application": {
        "type": "string"
      },
      "environment": {
        "type": "string",
        "pattern": "^(development|production)$"
      },
      "revoked": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The key identifiers stamped revoked by this call; empty where the realm held no live key."
      },
      "keys_changed_at": {
        "type": [
          "string",
          "null"
        ],
        "description": "The realm key set's version after the call, the value the sync route and the key-set route return as `version`."
      },
      "detail": {
        "type": "string"
      }
    },
    "additionalProperties": false
  }
}

Shared contracts #