Users

Update a user (admin)

Changed on

Update another user's name and/or email within your organization. You cannot edit your own profile through this endpoint.

patch/users/{id}

Request

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

Path parameters

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

User ID to update

Request body

namestring

New name for the user

emailstring

New email address for the user

Example request

{
  "name": "Maria Schmidt",
  "email": "maria.schmidt@gemeinde.de"
}

Response

User successfully updated

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