> ## 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.

# Verify User Logged In



## OpenAPI

````yaml GET /me
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:
  /me:
    get:
      tags:
        - public
      summary: Verify User Logged In
      operationId: verify_user_logged_in
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    UserInfo:
      properties:
        id:
          type: string
          title: Id
        email:
          type: string
          title: Email
        is_active:
          type: boolean
          title: Is Active
        is_superuser:
          type: boolean
          title: Is Superuser
        is_verified:
          type: boolean
          title: Is Verified
        role:
          $ref: '#/components/schemas/UserRole'
        preferences:
          $ref: '#/components/schemas/UserPreferences'
        personalization:
          $ref: '#/components/schemas/UserPersonalization'
        oidc_expiry:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Oidc Expiry
        current_token_created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Current Token Created At
        current_token_expiry_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Token Expiry Length
        is_cloud_superuser:
          type: boolean
          title: Is Cloud Superuser
          default: false
        team_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Name
        is_anonymous_user:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Anonymous User
        password_configured:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Password Configured
        tenant_info:
          anyOf:
            - $ref: '#/components/schemas/TenantInfo'
            - type: 'null'
      type: object
      required:
        - id
        - email
        - is_active
        - is_superuser
        - is_verified
        - role
        - preferences
      title: UserInfo
    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
    UserPreferences:
      properties:
        chosen_assistants:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Chosen Assistants
        hidden_assistants:
          items:
            type: integer
          type: array
          title: Hidden Assistants
          default: []
        visible_assistants:
          items:
            type: integer
          type: array
          title: Visible Assistants
          default: []
        default_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Model
        pinned_assistants:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Pinned Assistants
        shortcut_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Shortcut Enabled
        auto_scroll:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Auto Scroll
        temperature_override_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Temperature Override Enabled
        theme_preference:
          anyOf:
            - $ref: '#/components/schemas/ThemePreference'
            - type: 'null'
        assistant_specific_configs:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/UserSpecificAssistantPreference'
              type: object
            - type: 'null'
          title: Assistant Specific Configs
      type: object
      title: UserPreferences
    UserPersonalization:
      properties:
        name:
          type: string
          title: Name
          default: ''
        role:
          type: string
          title: Role
          default: ''
        use_memories:
          type: boolean
          title: Use Memories
          default: true
        memories:
          items:
            type: string
          type: array
          title: Memories
      type: object
      title: UserPersonalization
    TenantInfo:
      properties:
        invitation:
          anyOf:
            - $ref: '#/components/schemas/TenantSnapshot'
            - type: 'null'
        new_tenant:
          anyOf:
            - $ref: '#/components/schemas/TenantSnapshot'
            - type: 'null'
      type: object
      title: TenantInfo
    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
    ThemePreference:
      type: string
      enum:
        - light
        - dark
        - system
      title: ThemePreference
    UserSpecificAssistantPreference:
      properties:
        disabled_tool_ids:
          items:
            type: integer
          type: array
          title: Disabled Tool Ids
      type: object
      required:
        - disabled_tool_ids
      title: UserSpecificAssistantPreference
    TenantSnapshot:
      properties:
        number_of_users:
          type: integer
          title: Number Of Users
      type: object
      required:
        - number_of_users
      title: TenantSnapshot
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization header with Bearer token

````