V1 - Users

Create User

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.

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)
  • Auth
    API key in header X-API-Key

Request body

emailstring required
display_namestring nullable
tenant_rolestring nullable

Tenant role id or name; defaults to Base. Any other needs org:admin

metadataobject nullable
send_inviteboolean

Response

Successful Response

idstring required
emailstring required
display_namestring nullable
tenant_adminboolean required
is_activeboolean required
status'active' | 'pending' | 'suspended' required
tenant_role_idstring nullable
tenant_rolestring nullable
metadataobject

Changes

No recorded changes to this operation across all 1 revision of this API.