---
title: "Create an SSH or SFTP user"
url: https://docs.corefinity.com/api/reference/access/create-site-access-user
type: endpoint
last_updated: 2026-11-13
feature: access
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/connection-details.md
---
# Create an SSH or SFTP user

Adds a named user to the site or environment: `ssh` for SSH and SFTP over the whole site, or `sftp` for SFTP
only, limited to one folder. A generated password is in this answer and nowhere else, so asking for one also
needs the `exec` scope.

```http
POST /api/corestack/sites/{site}/access/users
```

- Scope: `write`
- Also needs `exec` when The body asks for a generated password (`password` is `generate`)
- Two-factor: required on your account (all)
- Rate limit: 30 a minute
- Long-running: answers with an operation to poll
- Try it in the console: off. It reveals a secret. Copy the request and run it yourself when you are sure.

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Body

- `label` (string or null): A note to recognise the user by.
- `password` (string or null): `none` (the default) makes a user that signs in with keys only. `set` uses `password_value`. `generate` makes a password and answers it once; it also needs the `exec` scope. One of `generate`, `set`, `none`, `null`.
- `password_value` (string or null): The password, with `set`, and needed then: 12 to 64 characters, not the username and not containing the site's domain. One that breaks these is refused on `password_value`.
- `root_path` (string or null): For `sftp` users, the folder the user is limited to, inside `htdocs` or `shared`. Left out, it is `htdocs`. Not accepted for `ssh` users. At most 200 characters, with no `/` at either end; each part is letters, digits, dots, dashes and underscores.
- `type` (string, required): `ssh` gives SSH and SFTP over the whole site. `sftp` gives SFTP only, inside `root_path`. One of `ssh`, `sftp`.
- `username` (string, required): 3 to 31 lower-case letters, digits or dashes, starting with a letter. Some names are reserved.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/access/users \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Photographer",
    "password": "generate",
    "root_path": "htdocs/wp-content/uploads",
    "type": "sftp",
    "username": "photographer"
  }'
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/access/users', [
        'label' => 'Photographer',
        'password' => 'generate',
        'root_path' => 'htdocs/wp-content/uploads',
        'type' => 'sftp',
        'username' => 'photographer',
    ]);

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/access/users', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    label: 'Photographer',
    password: 'generate',
    root_path: 'htdocs/wp-content/uploads',
    type: 'sftp',
    username: 'photographer',
  }),
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.post(
    "https://manage.corefinity.com/api/corestack/sites/1042/access/users",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "label": "Photographer",
        "password": "generate",
        "root_path": "htdocs/wp-content/uploads",
        "type": "sftp",
        "username": "photographer",
    },
)

data = res.json() if res.content else None
```

## Responses

### 201 The user was added and the change is being applied. Follow `operation.id` with `GET /corestack/sites/{site}/access/operations/{operation}`. `password` holds a generated password, once; the answer is sent with `Cache-Control: no-store`.

```json
{
  "access": {
    "apply": {
      "applied_at": "2026-11-03T10:03:10+00:00",
      "error": null,
      "operation": {
        "id": 5120,
        "scope": "site",
        "status": "committed",
        "status_label": "Waiting for the platform",
        "summary": "Add SFTP user photographer",
        "to_version": null,
        "type": "users_change",
        "type_label": "SSH / SFTP users"
      },
      "state": "applying",
      "state_label": "Applying"
    },
    "company_keys": [],
    "connection": {
      "host": "ssh-northwind.example.net",
      "port": 20101,
      "ssh_user": "web",
      "tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20101 web@ssh-northwind.example.net"
    },
    "limits": {
      "company_keys_max": 50,
      "keys_per_user_max": 50,
      "root_path_suggestions": [
        "htdocs",
        "htdocs/wp-content/uploads",
        "shared"
      ],
      "users_max": 25
    },
    "terminal": {
      "active_session": null,
      "available": true,
      "reason": null
    },
    "users": [
      {
        "can_change": false,
        "can_delete": false,
        "connection": {
          "command": "ssh -p 20101 web@ssh-northwind.example.net",
          "sftp_command": "sftp -P 20101 web@ssh-northwind.example.net"
        },
        "created_at": "2026-11-02T10:15:00+00:00",
        "created_by": null,
        "id": 417,
        "keys": [
          {
            "added_at": "2026-11-02T10:15:00+00:00",
            "added_by": null,
            "bits": 3072,
            "can_delete": false,
            "comment": "cfcp:deploy",
            "company_key_id": null,
            "fingerprint": "SHA256:ExampleDeployKeyFingerprintNotARealOne00000",
            "id": 0,
            "name": "cfcp-deploy",
            "restricted": false,
            "restrictions": [],
            "source": "system",
            "status": "applied",
            "status_label": "Applied",
            "type": "ssh-rsa"
          }
        ],
        "kind": "built_in",
        "label": null,
        "password": {
          "set": false,
          "set_at": null,
          "set_by": null
        },
        "root_path": null,
        "root_path_absolute": null,
        "status": "applied",
        "status_label": "Applied",
        "type": "ssh",
        "type_label": "SSH + SFTP",
        "uid": 9991,
        "username": "web"
      },
      {
        "can_change": true,
        "can_delete": true,
        "connection": {
          "command": null,
          "sftp_command": "sftp -P 20101 photographer@ssh-northwind.example.net"
        },
        "created_at": "2026-11-05T09:16:40+00:00",
        "created_by": {
          "id": 2011,
          "name": "Maya Okafor"
        },
        "id": 419,
        "keys": [],
        "kind": "named",
        "label": "Photographer",
        "password": {
          "set": true,
          "set_at": "2026-11-05T09:16:40+00:00",
          "set_by": {
            "id": 2011,
            "name": "Maya Okafor"
          }
        },
        "root_path": "htdocs/wp-content/uploads",
        "root_path_absolute": "/var/www/harbourandfinch.example.com/htdocs/wp-content/uploads",
        "status": "pending",
        "status_label": "Applying",
        "type": "sftp",
        "type_label": "SFTP only",
        "uid": 20002,
        "username": "photographer"
      },
      {
        "can_change": true,
        "can_delete": true,
        "connection": {
          "command": "ssh -p 20101 supplier@ssh-northwind.example.net",
          "sftp_command": "sftp -P 20101 supplier@ssh-northwind.example.net"
        },
        "created_at": "2026-11-02T10:15:00+00:00",
        "created_by": {
          "id": 2011,
          "name": "Maya Okafor"
        },
        "id": 3418,
        "keys": [
          {
            "added_at": "2026-11-03T10:02:44+00:00",
            "added_by": null,
            "bits": null,
            "can_delete": true,
            "comment": null,
            "company_key_id": null,
            "fingerprint": "SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0",
            "id": 7312,
            "name": "Supplier laptop",
            "restricted": false,
            "restrictions": [],
            "source": "user",
            "status": "applied",
            "status_label": "Applied",
            "type": "ssh-ed25519"
          }
        ],
        "kind": "named",
        "label": "Print supplier",
        "password": {
          "set": false,
          "set_at": null,
          "set_by": null
        },
        "root_path": null,
        "root_path_absolute": null,
        "status": "applied",
        "status_label": "Applied",
        "type": "ssh",
        "type_label": "SSH + SFTP",
        "uid": 20001,
        "username": "supplier"
      }
    ]
  },
  "operation": {
    "applied_at": null,
    "can_retry": false,
    "cluster": {
      "id": 17,
      "name": "WordPress Cluster 1"
    },
    "committed_at": "2026-11-05T09:16:40Z",
    "completed_at": null,
    "created_at": "2026-11-05T09:16:40Z",
    "environment": {
      "env_id": "rs-northwind-harbourandfinch-example-com",
      "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
      "id": 1042,
      "name": "Production",
      "role": "production",
      "role_label": "Production",
      "slug": "production"
    },
    "error": null,
    "failure_reason": null,
    "from_version": null,
    "hot": true,
    "id": 5120,
    "install": null,
    "label": "Picked up by the platform",
    "notes": [],
    "parent_operation_id": null,
    "requested_by": {
      "id": 2011,
      "name": "Maya Okafor"
    },
    "reset_target": null,
    "result": null,
    "result_state": "none",
    "retried_by_operation_id": null,
    "retries_operation_id": null,
    "retry_requires": null,
    "revealed": null,
    "scope": "site",
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "status": "committed",
    "status_label": "Waiting for the platform",
    "step": "applied",
    "steps": [
      {
        "key": "saved",
        "label": "Saved",
        "state": "done"
      },
      {
        "key": "applied",
        "label": "Picked up by the platform",
        "state": "current"
      },
      {
        "key": "live",
        "label": "Live",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "Add SFTP user photographer",
    "to_version": null,
    "type": "users_change",
    "type_label": "SSH / SFTP users"
  },
  "password": {
    "revealed_at": "2026-11-05T09:16:40+00:00",
    "value": "ExamplePasswordAbc23"
  },
  "user": {
    "can_change": true,
    "can_delete": true,
    "connection": {
      "command": null,
      "sftp_command": "sftp -P 20101 photographer@ssh-northwind.example.net"
    },
    "created_at": "2026-11-05T09:16:40+00:00",
    "created_by": {
      "id": 2011,
      "name": "Maya Okafor"
    },
    "id": 419,
    "keys": [],
    "kind": "named",
    "label": "Photographer",
    "password": {
      "set": true,
      "set_at": "2026-11-05T09:16:40+00:00",
      "set_by": {
        "id": 2011,
        "name": "Maya Okafor"
      }
    },
    "root_path": "htdocs/wp-content/uploads",
    "root_path_absolute": "/var/www/harbourandfinch.example.com/htdocs/wp-content/uploads",
    "status": "pending",
    "status_label": "Applying",
    "type": "sftp",
    "type_label": "SFTP only",
    "uid": 20002,
    "username": "photographer"
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use: `write`, or `exec` for a generated password), your company requires two-factor authentication and you have not set it up, your account has no company that can use Managed Clusters (`company_not_enabled`), or the key carries restrictions that only Corefinity changes (`restricted`).

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 The change was refused because of the site's state. `reason` says why: `busy` (another change to this site is running), `in_use` (the user or key is still being removed, or the key is a company, website or personal key that is removed where it was added), `not_imported` (the site's keys are not managed here yet), `removed` (the site has been removed), `conflict` (the site changed while the change was being saved) or `managed_elsewhere` (another control panel manages the site). A change that could not be saved answers a message only, and a refusal after the change was recorded also carries the failed `operation`. A key of the built-in `web` user, while SSH keys are on, is refused as the SSH keys API refuses it: `ssh_key_duplicate` or `ssh_managed_on_another_environment`.

```json
{
  "code": "busy",
  "message": "Another change to this site is in progress. Wait for it to finish.",
  "reason": "busy"
}
```

### 422 A field is missing or wrong, or the user cannot be made or changed as asked (`invalid`; `field` names the field when the refusal is about one). A username that is a person's own SSH username is refused with the reason `ssh_person_managed_elsewhere`.

```json
{
  "code": "invalid",
  "message": "This user cannot be changed",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

### 502 The platform could not be reached, or did not save the change. Try again in a minute.

```json
{
  "message": "The platform could not be reached. Try again in a minute."
}
```

### 503 The platform is not ready to apply changes to users and keys. The change was recorded and failed, and the failed `operation` is in the answer. There is no `reason` or `code`. Contact support.

```json
{
  "message": "The platform deploy key is not configured. Contact support."
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `restricted` | Restricted keys are changed by staff. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 409 | `busy` | Another operation is running on the site. Wait for it to finish. |
| 409 | `in_use` | It is still in use, still being removed, or managed somewhere else. Read the message: wait for the removal, remove what uses it first, or remove it where the message says. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `ssh_key_duplicate` | The key is already added here. Use the existing one. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 422 | `ssh_person_managed_elsewhere` | That username belongs to a person's own SSH login, managed in their profile. Choose another name. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 502 |  | Read the message; it says what happened. |
| 503 |  | Try again shortly. |

## The same task elsewhere

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