Skip to main content
PUT
Update a user

Path Parameters

userId
string<uuid>
required

Unique identifier of the user to update

Body

application/json
firstName
string

Updated first name

lastName
string

Updated last name

status
enum<string>

Updated user status

Available options:
active,
disabled,
locked
type
enum<string>

Updated user type

Available options:
invited,
member,
author,
admin,
owner
roles
string<uuid>[]

List of role IDs to assign to the user

Role ID

Response

200 - application/json

The updated user

The updated user

id
string<uuid>
required

Unique identifier of the user

email
string<email>
required

Email address of the user

type
enum<string>
required

User type/role within the organisation

Available options:
invited,
member,
author,
admin,
owner
status
enum<string>
required

Current status of the user account

Available options:
active,
disabled,
locked
createdAt
string
required

Timestamp when the user was created

updatedAt
string
required

Timestamp when the user was last updated

firstName
string | null

First name of the user

lastName
string | null

Last name of the user

isService
boolean

Whether this is a service account

roles
object[]

Roles assigned to the user