---
title: "Reveal an HTTP authentication password"
url: https://docs.corefinity.com/api/reference/access/reveal-site-http-auth-password
type: endpoint
last_updated: 2026-11-13
feature: http-auth
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md
  - https://docs.corefinity.com/mcp/tools/corestack_http_auth_reveal_password.md
---
# Reveal an HTTP authentication password

Answers one user's current password to the token's own person. Every reveal is recorded with who revealed it
and when, and the answer is never cached.

```http
POST /api/corestack/sites/{site}/http-auth/users/{user}/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.
- `user` (integer, required): The id of an HTTP authentication user of this site, from the read. Digits only.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/http-auth/users/71/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/http-auth/users/71/reveal');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/http-auth/users/71/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/http-auth/users/71/reveal",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The user's password, sent with `Cache-Control: no-store, private`.

```json
{
  "password": "Example-client-2026",
  "revealed_at": "2026-11-06T15:05:00Z",
  "rule_id": 51,
  "user_id": 71,
  "username": "client"
}
```

### 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 it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 409 The user was carried over as a password hash, so there is no password to show (`legacy_hash`; set a new password for it), or another control panel manages the site (`managed_elsewhere`).

```json
{
  "code": "legacy_hash",
  "message": "Carried from the previous environment as a legacy password hash: it signs in as before, but its password cannot be shown. Set a new password for it.",
  "reason": "legacy_hash"
}
```

### 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 stored password could not be read. Contact support.

```json
{
  "message": "This password cannot be shown. 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 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 |  | Check the id. You see only what your account can reach. |
| 409 | `legacy_hash` | Carried from the previous environment as a legacy password hash: it signs in as before, but its password cannot be shown. Set a new password for it. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 502 |  | Read the message; it says what happened. |

## The same task elsewhere

- Guide: [Password protection](https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md)
- MCP tool: [`corestack_http_auth_reveal_password`](https://docs.corefinity.com/mcp/tools/corestack_http_auth_reveal_password.md)
