---
title: "corestack_ssh_user_update"
url: https://docs.corefinity.com/mcp/tools/corestack_ssh_user_update
type: tool
last_updated: 2026-11-13
feature: access
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/connection-details.md
---
# corestack_ssh_user_update

**Change an SSH user.** Change an SSH or SFTP user: its type, root path, label or password (set, generate or clear). Scope: write. Also needs exec when reveal_to_agent is true. Long-running: answers with a task. The secret opens in the person's browser; set reveal_to_agent to true to receive it yourself (needs exec).

- Scope: `write`
- Also needs `exec` when a generated password
- Runs as a task: yes
- Returns a secret only when `reveal_to_agent` is set

## When to use it

Change an SSH or SFTP user: its type, root path, label or password (set, generate or clear).

## Inputs

- `user_id` (integer, ≥ 1, required)
- `type` (one of `ssh`, `sftp`)
- `root_path` (string, up to 255 characters)
- `label` (string, up to 255 characters)
- `password` (one of `generate`, `set`, `clear`, `none`)
- `password_value` (string, up to 256 characters)
- `reveal_to_agent` (boolean, default `false`): Return the secret to you instead of opening it in the person's browser. Needs exec.

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "label": {
      "maxLength": 255,
      "type": "string"
    },
    "password": {
      "enum": [
        "generate",
        "set",
        "clear",
        "none"
      ],
      "type": "string"
    },
    "password_value": {
      "maxLength": 256,
      "type": "string"
    },
    "reveal_to_agent": {
      "default": false,
      "description": "Return the secret to you instead of opening it in the person's browser. Needs exec.",
      "type": "boolean"
    },
    "root_path": {
      "maxLength": 255,
      "type": "string"
    },
    "type": {
      "enum": [
        "ssh",
        "sftp"
      ],
      "type": "string"
    },
    "user_id": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "user_id"
  ],
  "type": "object"
}
```

## Refusals

- `ssh_person_managed_elsewhere`: the user is a person's own SSH login, managed in their profile (while `ssh_keys` is on).
- `managed_elsewhere` (message: "This site is managed by another control panel"): another control panel manages this site, so use that control panel for it. This is refused before anything else about the site, as in the Control Panel and the API. Nothing was done.
- The refusals every tool can answer: `invalid_arguments`, `tenant_mismatch`, `scope_required`, `pin_refused`, `rate_limited`, `temporarily_unavailable`, `internal_error` (corestack://guides/how-this-server-works).

## Example

```json
{
  "name": "corestack_ssh_user_update",
  "arguments": {
    "user_id": 5021
  }
}
```

## Prompt

```text
Using the Corefinity MCP server, call corestack_ssh_user_update with user_id 5021. (Change an SSH user.) Tell me what it returned.
```

## The same task elsewhere

- Guide: [Connection details](https://docs.corefinity.com/guides/sites/access-and-security/connection-details.md)
