---
title: "Reveal a generated password once"
url: https://docs.corefinity.com/api/reference/database/reveal-site-database-user-password
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_password_reveal.md
---
# Reveal a generated password once

Answers the password generated when the user was added or its password last rotated: once, within 24 hours,
to the person who made that change, after its operation has completed. It needs the `exec` scope, the answer
is never cached and the reveal is recorded.

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

- Scope: `exec`
- Two-factor: required on your account (all)
- Rate limit: 10 a minute
- 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.
- `username` (string, required): A database user's name, as the database details list it.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/reveal \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### 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/reporting_ro/reveal');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/database/users/reporting_ro/reveal', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// 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/reporting_ro/reveal",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The password, this once. Keep it out of logs and tickets.

```json
{
  "password": "example-password-not-a-secret",
  "username": "reporting_ro"
}
```

### 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 site id does not exist or is a site you cannot change, the feature is not on for your company (`feature_off`), or no user of that name on this environment can be changed from here (`user_not_found`): an unknown name, the site's own `application` login and the platform's own accounts all answer the same body.

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

### 409 The site is managed by another control panel, so it cannot be changed here.

```json
{
  "code": "managed_elsewhere",
  "message": "This site is managed by another control panel",
  "reason": "managed_elsewhere"
}
```

### 410 The password cannot be shown (`reveal_gone`): it was shown already, you set it yourself, it is more than 24 hours old, somebody else made the change, or a later rotation replaced it. Rotate the password to get a new one.

```json
{
  "code": "reveal_gone",
  "message": "This password can no longer be shown. Rotate it to get a new one.",
  "reason": "reveal_gone"
}
```

### 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
}
```

## 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. |
| 404 | `user_not_found` | There is no such database user on the environment. Read the users again. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 410 | `reveal_gone` | The password can no longer be shown. Rotate it to get a new one. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

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