Skip to main content
PATCH
/
users
/
{id}
Users:Patch User
curl --request PATCH \
  --url https://cloud.onyx.app/api/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "password": "<string>",
  "email": "jsmith@example.com",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "is_active": true,
  "is_superuser": false,
  "is_verified": false,
  "role": "limited"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json

Role updates are not allowed through the user update endpoint for security reasons Role changes should be handled through a separate, admin-only process

​
password
string | null
​
email
string<email> | null
​
is_active
boolean | null
​
is_superuser
boolean | null
​
is_verified
boolean | null

Response

Successful Response

​
id
string<uuid>
​
email
string<email>
​
is_active
boolean
default:true
​
is_superuser
boolean
default:false
​
is_verified
boolean
default:false
​
role
enum<string>

User roles

  • Basic can't perform any admin actions
  • Admin can perform all admin actions
  • Curator can perform admin actions for groups they are curators of
  • Global Curator can perform admin actions for all groups they are a member of
  • Limited can access a limited set of basic api endpoints
  • Slack are users that have used Onyx via slack but dont have a web login
  • External permissioned users that have been picked up during the external permissions sync process but don't have a web login
Available options:
limited,
basic,
admin,
curator,
global_curator,
slack_user,
ext_perm_user
⌘I