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

# List or Retrieve users

> Automatic filtering on company defined in get_extra_model_filter_kwargs_getter()



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /scim/v2/Users
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /scim/v2/Users:
    get:
      tags:
        - SCIM
      summary: List or Retrieve users
      description: >-
        Automatic filtering on company defined in
        get_extra_model_filter_kwargs_getter()
      operationId: scim_v2_Users_retrieve
      responses:
        '200':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMPaginatedUsers'
          description: Users list
        '401':
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/SCIMErrorResponse'
              examples:
                Unauthorized:
                  value:
                    schemas:
                      - urn:ietf:params:scim:api:messages:2.0:Error
                    detail: Unauthorized
                    status: 401
          description: Authentication required
      security:
        - bearerAuth: []
components:
  schemas:
    SCIMPaginatedUsers:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          default:
            - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults:
          type: integer
          default: 0
        itemsPerPage:
          type: integer
          default: 50
        startIndex:
          type: integer
          default: 0
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/SCIMUserResponse'
      required:
        - Resources
    SCIMErrorResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          default:
            - urn:ietf:params:scim:api:messages:2.0:Error
        detail:
          type: string
        status:
          type: integer
      required:
        - detail
        - status
    SCIMUserResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          readOnly: true
          default:
            - urn:ietf:params:scim:schemas:core:2.0:User
        id:
          type: string
          readOnly: true
        externalId:
          type: string
          readOnly: true
        userName:
          type: string
          readOnly: true
        name:
          allOf:
            - $ref: '#/components/schemas/SCIMUserNameResponse'
          readOnly: true
        displayName:
          type: string
          readOnly: true
        emails:
          type: array
          items:
            $ref: '#/components/schemas/SCIMUserEmailResponse'
          readOnly: true
        title:
          type: string
          readOnly: true
        preferredLanguage:
          allOf:
            - $ref: '#/components/schemas/PreferredLanguageEnum'
          readOnly: true
        active:
          type: boolean
          readOnly: true
        groups:
          type: array
          items:
            $ref: '#/components/schemas/SCIMUserGroupResponse'
          readOnly: true
        meta:
          allOf:
            - $ref: '#/components/schemas/SCIMUserMetaResponse'
          readOnly: true
      required:
        - active
        - displayName
        - emails
        - externalId
        - groups
        - id
        - meta
        - name
        - preferredLanguage
        - schemas
        - title
        - userName
    SCIMUserNameResponse:
      type: object
      properties:
        givenName:
          type: string
        familyName:
          type: string
        formatted:
          type: string
      required:
        - familyName
        - formatted
        - givenName
    SCIMUserEmailResponse:
      type: object
      properties:
        value:
          type: string
        primary:
          type: boolean
      required:
        - primary
        - value
    PreferredLanguageEnum:
      enum:
        - ar
        - en
        - fr
        - de
      type: string
      description: |-
        * `ar` - Arabic
        * `en` - English
        * `fr` - French
        * `de` - German
    SCIMUserGroupResponse:
      type: object
      properties:
        value:
          type: string
        display:
          type: string
      required:
        - display
        - value
    SCIMUserMetaResponse:
      type: object
      properties:
        resourceType:
          type: string
          default: User
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        location:
          type: string
      required:
        - created
        - lastModified
        - location
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````