> API Reference / Authentication / Create new auth user

## POST /projects//branches//auth/users

Creates a new user in the Neon Auth user directory for the specified branch.
The user is created in the `neon_auth.users_sync` table and can immediately authenticate
using the branch's configured auth providers.

### Parameters

- `project_id` (string, path, required)
  The Neon project ID
- `branch_id` (string, path, required)
  The Neon branch ID

### Request body

- `email` (string, required, format: email)
  Email address of the new Neon Auth user to create.
- `name` (string, optional)
  Display name for the new user. Optional. Pair with the required email field when creating a new user.

### Response (201)

```json
{
  "id": "00000000-0000-0000-0000-000000000000"
}
```

### Code examples

```bash
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/users" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"
```

```typescript
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createBranchNeonAuthNewUser({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});
```

```bash
# neonctl
neon neon-auth user create
```

### Console

Console path: Projects → Auth → Users

### Errors

**default**
General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code,
and whether a response was received.

- If no response is returned from the API, a network error or timeout likely occurred.
- In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**.
The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout.

Any request that returns a `503 Service Unavailable` response is always safe to retry.

Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.

- `request_id` (string, optional)
  Unique identifier for the request, useful for debugging.
  You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

- `code` (string, required)
  Machine-readable code classifying the error type. See `message` for a human-readable explanation.
  Default: \`\`

- `message` (string, required)
  Error message

## Related pages

- [Add an OAuth provider](./apis-sdks-reference-api-auth-add-branch-neon-auth-oauth-provider.md)
- [Add domain to redirect_uri whitelist](./apis-sdks-reference-api-auth-add-branch-neon-auth-trusted-domain.md)
- [Delete auth user](./apis-sdks-reference-api-auth-delete-branch-neon-auth-user.md)
- [Delete domain from redirect_uri whitelist](./apis-sdks-reference-api-auth-delete-branch-neon-auth-trusted-domain.md)
- [Delete OAuth provider](./apis-sdks-reference-api-auth-delete-branch-neon-auth-oauth-provider.md)
- [Disable Neon Auth for the branch](./apis-sdks-reference-api-auth-disable-neon-auth.md)
- [Enable Neon Auth for the branch](./apis-sdks-reference-api-auth-create-neon-auth.md)
- [List domains in redirect_uri whitelist](./apis-sdks-reference-api-auth-list-branch-neon-auth-trusted-domains.md)
- [List OAuth providers for the branch](./apis-sdks-reference-api-auth-list-branch-neon-auth-oauth-providers.md)
- [Retrieve email and password configuration](./apis-sdks-reference-api-auth-get-neon-auth-email-and-password-config.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.