Skip to main content
PATCH
Update user (CLI/SDK)

Path Parameters

id
string
required

User UUID

Body

application/json
email
string<email>

User email address

Example:

"john.doe@acme.com"

phone
string

User phone number

Example:

"+5511999999999"

name
string

User full name

Required string length: 2 - 100
Example:

"John Doe"

avatarUrl
string

User avatar URL

Maximum string length: 500
Example:

"https://example.com/avatar.jpg"

isActive
boolean

Whether the user is active

Example:

true

role
enum<string>

User role within the tenant

Available options:
ADMIN,
USER,
VIEWER,
SUPER_ADMIN,
HUB_USER
Example:

"USER"

Response

200 - application/json

User updated successfully.

id
string
required

User unique identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

email
string
required

User email address

Example:

"john.doe@acme.com"

name
string
required

User full name

Example:

"John Doe"

role
enum<string>
required

User role within the tenant

Available options:
ADMIN,
USER,
VIEWER,
SUPER_ADMIN,
HUB_USER
Example:

"USER"

isActive
boolean
required

Whether the user is active

Example:

true

lastLoginAt
string<date-time>
required

User last login timestamp

Example:

"2025-01-01T00:00:00.000Z"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-01-01T00:00:00.000Z"

tenantId
string
required

Tenant ID that the user belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

phone
string

User phone number

Example:

"+5511999999999"

avatarUrl
string

User avatar URL

Example:

"https://example.com/avatar.jpg"

metadata
object

User metadata (Auth0 integration data)

Example:
_count
object

User related statistics

Example: