Skip to main content
PUT
Update a User

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

User to be updated

userId
string
Maximum string length: 50
displayName
string
Maximum string length: 100
profileHandle
string
Maximum string length: 100
roles
string[]

Only administrator can update system roles (moderator and admin)

Maximum array length: 10
Maximum string length: 100
metadata
object

User metadata (max: 5,000 bytes)

avatarFileId
string
Maximum string length: 50
avatarCustomUrl
string
Maximum string length: 1000
description
string
Maximum string length: 500

Response

User

users
object[]
roles
object[]
files
object[]