# Redeem a one-time impersonation ticket for the app's callback URL

The second half of the console's "Sign in as user": no router-level gate, the org comes in the body.

`POST /api/v1/auth/impersonation/redeem`

- Sign-in: None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 30 requests a minute per IP address.

The second half of the console's "Sign in as user": no router-level gate, the org comes in the body. Spends the ticket, mints the impersonation code and returns the app's callback URL with `code` and the given `state`; the redemption is written to the security audit log.

## Request

Send the body as `application/json`.

| Field      | Type   | Required | Constraints                 | Description |
| ---------- | ------ | -------- | --------------------------- | ----------- |
| `orgId`    | string | Yes      | format `tenantKey`          | -           |
| `clientId` | string | Yes      | 1 to 128 characters         | -           |
| `ticket`   | string | Yes      | matches `^[0-9A-Za-z]{48}$` | -           |
| `state`    | string | Yes      | 1 to 128 characters         | -           |

## Example request

Replace each `YOUR_...` value with your own.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/auth/impersonation/redeem" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "YOUR_ORG_ID",
  "clientId": "YOUR_CLIENT_ID",
  "ticket": "string",
  "state": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/impersonation/redeem',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      orgId: 'YOUR_ORG_ID',
      clientId: 'YOUR_CLIENT_ID',
      ticket: 'string',
      state: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/auth/impersonation/redeem",
    json={
        "orgId": "YOUR_ORG_ID",
        "clientId": "YOUR_CLIENT_ID",
        "ticket": "string",
        "state": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "data": {
    "redirectUrl": "http://localhost:9999/callback?code=[REDACTED]&state=[REDACTED]"
  },
  "success": true
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 404 Not Found

**What it means:** An id in the path names nothing in this org.

**What to do:** Check the ids in the path: one of them names nothing in this organization.

```json title="Example"
{
  "success": false,
  "message": "string"
}
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Auth guide](/authentication/overview): how this part of BuildBase works
- [All Auth operations](/http-api/reference/auth)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `auth.impersonation.redeem.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
