Sign in
Super Admin Users

Create a new user in an organization

Changed on

Create a new user in the specified organization with a randomly generated password. A password reset email will be sent to the user. This endpoint is only accessible to super admins.

post/super-admin/users/{orgId}/create

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Organization ID to create the user in

Request body

emailstring required

Email address for the user

namestring required

Name of the user

role'admin' | 'manager' | 'user' required

Role for the user

sendActivationEmailboolean required

Send the account activation (welcome) email to the new user

Example request

{
  "email": "user@example.com",
  "name": "John Doe",
  "role": "user",
  "sendActivationEmail": true
}

Response

User created successfully

idstring uuid required

User unique identifier

namestring required

User name

emailstring required

User email address

role'admin' | 'manager' | 'user' required

User role

orgIdstring uuid required

Organization ID the user belongs to

departmentstring nullable

Department the user belongs to

isLockedboolean

Whether the account is locked after failed login attempts

createdAtstring date-time required

Date when the user was created

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "user",
  "orgId": "123e4567-e89b-12d3-a456-426614174001",
  "department": "hauptamt",
  "createdAt": "2024-01-15T10:30:00Z"
}

Changes