# Start a hosted sign-in and get the sign-in page URL

No router-level gate: the org and client come in the body.

`POST /api/v1/auth/request`

- 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 300 requests a minute per IP address.

No router-level gate: the org and client come in the body. Checks the client belongs to the org and both redirect URLs are registered for it, refuses agent clients (they use the OAuth2 flow), stores the sign-in state and returns the hosted page URL. Answers 503 `temporarily_unavailable` when the state cannot be stored.

## Request

Send the body as `application/json`.

| Field                            | Type    | Required | Constraints                                                                                                                        | Description |
| -------------------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `orgId`                          | string  | Yes      | format `tenantKey`                                                                                                                 | -           |
| `clientId`                       | string  | Yes      | -                                                                                                                                  | -           |
| `redirect`                       | object  | Yes      | -                                                                                                                                  | -           |
| `redirect.success`               | string  | Yes      | format `uri`                                                                                                                       | -           |
| `redirect.error`                 | string  | Yes      | format `uri`                                                                                                                       | -           |
| `state`                          | string  | No       | 1 to 128 characters                                                                                                                | -           |
| `trackingConsent`                | object  | No       | -                                                                                                                                  | -           |
| `trackingConsent.analytics`      | boolean | No       | -                                                                                                                                  | -           |
| `trackingConsent.marketing`      | boolean | No       | -                                                                                                                                  | -           |
| `trackingIdentity`               | object  | No       | -                                                                                                                                  | -           |
| `trackingIdentity.gaClientId`    | string  | No       | matches `^[0-9]{1,20}\.[0-9]{1,20}$`                                                                                               | -           |
| `trackingIdentity.gaSessionId`   | string  | No       | matches `^[0-9]{1,20}$`                                                                                                            | -           |
| `trackingAttribution`            | object  | No       | -                                                                                                                                  | -           |
| `trackingAttribution.params`     | object  | No       | -                                                                                                                                  | -           |
| `trackingAttribution.capturedAt` | integer | No       | at least 0                                                                                                                         | -           |
| `trackingAttribution.landingUrl` | string  | No       | at most 500 characters                                                                                                             | -           |
| `invitationToken`                | string  | No       | matches `^[0-9a-f]{64}$`                                                                                                           | -           |
| `locale`                         | string  | No       | matches `^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$`                                                                                      | -           |
| `notice`                         | object  | No       | -                                                                                                                                  | -           |
| `notice.reason`                  | string  | No       | one of `"enterprise_idle"`, `"enterprise_max_age"`, `"enterprise_signout"`, `"enterprise_session_ended"`, `"enterprise_workspace"` | -           |
| `notice.minutes`                 | integer | No       | at least 1, at most 1000000                                                                                                        | -           |

## Example request

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

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/auth/request" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "YOUR_ORG_ID",
  "clientId": "YOUR_CLIENT_ID",
  "redirect": {
    "success": "https://example.com",
    "error": "https://example.com"
  }
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/request',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      orgId: 'YOUR_ORG_ID',
      clientId: 'YOUR_CLIENT_ID',
      redirect: {
        success: 'https://example.com',
        error: 'https://example.com',
      },
    }),
  }
);
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/request",
    json={
        "orgId": "YOUR_ORG_ID",
        "clientId": "YOUR_CLIENT_ID",
        "redirect": {
            "success": "https://example.com",
            "error": "https://example.com",
        },
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "message": "Agent clients must use the OAuth2 authorization flow (see the org discovery document at /.well-known/oauth-authorization-server).",
  "success": false
}
```

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