Skip to main content
PATCH
/
manage
/
set-user-role
Set User Role
curl --request PATCH \
  --url https://cloud.onyx.app/api/manage/set-user-role \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_email": "<string>",
  "new_role": "limited",
  "explicit_override": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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