---
title: "Create a database user"
url: https://docs.corefinity.com/api/reference/database/create-site-database-user
type: endpoint
last_updated: 2026-11-13
feature: database
related:
  - https://docs.corefinity.com/guides/sites/database/database-users.md
  - https://docs.corefinity.com/mcp/tools/corestack_external_db_user_add.md
---
# Create a database user

Adds a database user to the environment: an `internal` user connects from inside the site only, an `external`
user through external access only. A generated password is never in the answer: once the operation completes,
reveal it once with the reveal endpoint. Try-it is off because the request creates a login.

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

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 20 a minute
- Long-running: answers with an operation to poll
- Try it in the console: off. It has not been cleared for the console. 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

- `confirm_read_write` (string): Sent with `scope: read_write`.
- `kind` (string, required): `internal` connects from inside the site only. `external` connects through external access only, which must be on. One of `internal`, `external`.
- `max_statement_time` (integer or null): The longest statement, in seconds, from 1 to 86400. Null or absent for no limit. External users only.
- `max_user_connections` (integer or null): The most connections at once, from 1 to 1000. Null or absent for no limit. External users only.
- `password` (object, required)
  - `mode` (string, required): `generate`: a 24-character password, revealed once. `set`: your own, in `value`. One of `generate`, `set`.
  - `value` (string): Your own password, with `mode: set`. 12 to 64 printable characters, without spaces, quotes, backticks or backslashes.
- `require_tls` (boolean): Refuse connections that are not encrypted. External users only.
- `scope` (string, required): `read_only`: `SELECT` and `SHOW VIEW`. `read_write`: also changing and deleting data. One of `read_only`, `read_write`.
- `username` (string, required): 3 to 32 lower-case letters, digits and underscores, starting with a letter. Some names are kept for the platform.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/database/users \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "confirm_read_write": "read-write",
    "kind": "external",
    "max_statement_time": 30,
    "max_user_connections": 5,
    "password": {
      "mode": "set",
      "value": "example-password-not-a-secret"
    },
    "require_tls": true,
    "scope": "read_write",
    "username": "erp_sync"
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/database/users', [
        'confirm_read_write' => 'read-write',
        'kind' => 'external',
        'max_statement_time' => 30,
        'max_user_connections' => 5,
        'password' => [
            'mode' => 'set',
            'value' => 'example-password-not-a-secret',
        ],
        'require_tls' => true,
        'scope' => 'read_write',
        'username' => 'erp_sync',
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/database/users', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    confirm_read_write: 'read-write',
    kind: 'external',
    max_statement_time: 30,
    max_user_connections: 5,
    password: {
      mode: 'set',
      value: 'example-password-not-a-secret',
    },
    require_tls: true,
    scope: 'read_write',
    username: 'erp_sync',
  }),
});

// 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/database/users",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "confirm_read_write": "read-write",
        "kind": "external",
        "max_statement_time": 30,
        "max_user_connections": 5,
        "password": {
            "mode": "set",
            "value": "example-password-not-a-secret",
        },
        "require_tls": True,
        "scope": "read_write",
        "username": "erp_sync",
    },
)

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

## Responses

### 202 The user is being added. Follow `operation.id` until it completes.

```json
{
  "operation": {
    "applied_at": "2026-11-03T09:16:40Z",
    "can_retry": false,
    "cluster": {
      "id": 1017,
      "name": "Northwind UK 1"
    },
    "committed_at": null,
    "completed_at": null,
    "created_at": "2026-11-03T09: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": false,
    "id": 5120,
    "install": null,
    "label": "Saved",
    "notes": [],
    "parent_operation_id": null,
    "requested_by": {
      "id": 2012,
      "name": "Daniel Reyes"
    },
    "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": "executing",
    "status_label": "Saving the change",
    "step": "saved",
    "steps": [
      {
        "key": "saved",
        "label": "Saved",
        "state": "current"
      },
      {
        "key": "applied",
        "label": "Applied in the database",
        "state": "todo"
      }
    ],
    "subject": null,
    "summary": "User reports_ro added (internal, read-only)",
    "to_version": null,
    "type": "db_user_change",
    "type_label": "Database users"
  }
}
```

### 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), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```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: `deleted`, `provisioning`, `busy` (another change is running), `restore_running`, `removed` or `managed_elsewhere`.

```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 (`invalid`, with `field` and `errors`): the name, the password, a limit, or a `read_write` user without `confirm_read_write`. A `confirm_read_write` that is typed and is not `read-write` is `invalid` too, with `detail_reason: confirm_mismatch` beside it. Or the user cannot be added: `user_cap` (the environment already has 10 users, or 5 external ones) or `external_off` (an external user needs external access on first).

```json
{
  "code": "invalid",
  "errors": {
    "max_user_connections": [
      "Use a whole number from 1 to 1000, or leave it empty for no limit."
    ]
  },
  "field": "max_user_connections",
  "message": "Use a whole number from 1 to 1000, or leave it empty for no limit.",
  "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
}
```

### 503 Corefinity has switched changes to database users off for the moment (`switched_off`). Try again later.

```json
{
  "code": "switched_off",
  "message": "Database users can't be changed just now. Try again later.",
  "reason": "switched_off"
}
```

## 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 | `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 | `deleted` | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `provisioning` | The site is still being created. Try again in a few minutes. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 422 | `external_off` | External access is off, and external users connect through it. Turn external access on first. |
| 422 | `user_cap` | The environment holds as many database users as it can. Delete one you no longer need, or ask support. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 503 | `switched_off` | Corefinity has switched this action off for the moment. Try again later. |

## The same task elsewhere

- Guide: [Database users](https://docs.corefinity.com/guides/sites/database/database-users.md)
- MCP tool: [`corestack_external_db_user_add`](https://docs.corefinity.com/mcp/tools/corestack_external_db_user_add.md)
