Sign in
Super Admin Management

Promote a user to super admin

Changed on

Promote an existing user to super admin by email address. Idempotent if user is already a super admin.

post/super-admin/super-admins

Request

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

Request body

emailstring required

Email address of the user to promote to super admin

Example request

{
  "email": "user@example.com"
}

Response

User promoted to super admin (or already a super admin)

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

systemRole'customer' | 'super_admin' required

System-level role of the user

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",
  "systemRole": "super_admin"
}

Changes