public

Set User Role

patch/manage/set-user-role

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/manage/set-user-role
  • Auth
    HTTP bearer

Request body

user_emailstring required
new_role'limited' | 'basic' | 'admin' | 'curator' | 'global_curator' | 'slack_user' | 'ext_perm_user' 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
explicit_overrideboolean

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.