# Revoke a user's grant to an OAuth client

The caller authenticates with its client credentials (401 invalid_client otherwise) and revokes its own grant, or another client's when it is not an agent...

`POST /api/v1/auth/consent/revoke`

- Sign-in: No credential. Name the organization with the hosted sign-in state header or the org query parameter.
- 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 caller authenticates with its client credentials (401 `invalid_client` otherwise) and revokes its own grant, or another client's when it is not an agent client (403 otherwise). Removes the consent, the user's refresh tokens and sessions for that client, and notifies the client of the revocation.

## Request

Send the body as `application/json`. The body is optional.

| Field            | Type   | Required | Constraints             | Description |
| ---------------- | ------ | -------- | ----------------------- | ----------- |
| `client_id`      | string | No       | at most 256 characters  | -           |
| `client_secret`  | string | No       | at most 1024 characters | -           |
| `userId`         | string | No       | at most 64 characters   | -           |
| `targetClientId` | string | No       | at most 256 characters  | -           |

## Example request

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

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/auth/consent/revoke?org=YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "string",
  "userId": "YOUR_USER_ID"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/consent/revoke?org=YOUR_ORG_ID',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      client_id: 'YOUR_CLIENT_ID',
      client_secret: 'string',
      userId: 'YOUR_USER_ID',
    }),
  }
);
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/consent/revoke?org=YOUR_ORG_ID",
    json={
        "client_id": "YOUR_CLIENT_ID",
        "client_secret": "string",
        "userId": "YOUR_USER_ID",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "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"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 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.consent.revoke.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
