> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Set User Role



## OpenAPI

````yaml PATCH /manage/set-user-role
openapi: 3.1.0
info:
  title: Onyx API
  description: Onyx API for AI-powered enterprise search and chat
  version: Development
servers:
  - url: https://cloud.onyx.app/api
security: []
paths:
  /manage/set-user-role:
    patch:
      tags:
        - public
      summary: Set User Role
      operationId: set_user_role
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    UserRoleUpdateRequest:
      properties:
        user_email:
          type: string
          title: User Email
        new_role:
          $ref: '#/components/schemas/UserRole'
        explicit_override:
          type: boolean
          title: Explicit Override
          default: false
      type: object
      required:
        - user_email
        - new_role
      title: UserRoleUpdateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserRole:
      type: string
      enum:
        - limited
        - basic
        - admin
        - curator
        - global_curator
        - slack_user
        - ext_perm_user
      title: UserRole
      description: >-
        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
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization header with Bearer token

````