---
title: "Create User"
method: POST
path: "/v1/admin/users"
tags: ["V1 - Users"]
---

# Create User

`POST /v1/admin/users`

## Request

- Base URL: `https://api.app.noxus.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.noxus.ai/v1/admin/users`
- Auth: API key in header `X-API-Key`

Create a user who signs in later (matched by email), with their tenant
role and workspaces. ``send_invite`` emails them the welcome message.

A key without ``org:admin`` can only create users with the Base tenant role
and the Runner workspace role, as inviting from the app does.

## Request body

- CreateUserRequest
  - `email` string, required
  - `display_name` string, nullable
  - `tenant_role` string, nullable: Tenant role id or name; defaults to Base. Any other needs org:admin
  - `workspaces` WorkspaceAssignment[]: Workspace roles other than Runner need org:admin. Without any, the user joins the fallback workspace
    - `workspace_id` string, uuid, required
    - `role` string, required: Workspace role id or name, e.g. Editor
  - `metadata` object, nullable
  - `send_invite` boolean

## Response `201`

Successful Response

- TenantUserDetail
  - `id` string, required
  - `email` string, required
  - `display_name` string, nullable
  - `tenant_admin` boolean, required
  - `is_active` boolean, required
  - `status` 'active' | 'pending' | 'suspended', required
  - `tenant_role_id` string, nullable
  - `tenant_role` string, nullable
  - `metadata` object
  - `memberships` Membership[]
    - `workspace_id` string, required
    - `workspace_name` string, required
    - `role_id` string, nullable, required
    - `role` string, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/noxus/apis/noxus-backend.md) - [All operations](https://skmtc.dev/noxus/apis/noxus-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/noxus/apis/noxus-backend/revisions/0e37810b7ad5?raw)