Skip to main content
PATCH
Set User Role
This endpoint applies only to Onyx versions before v4.7. For Onyx v4.7 and later, use Set User Admin Access to toggle Admin group membership. To grant other permissions, add the user to a group that grants them.

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
user_email
string
required
new_role
enum<string>
required

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
explicit_override
boolean
default:false

Response

Successful Response