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

# Create User Group

> [!NOTE]
>
> **Business Edition Feature**
>
> This feature requires a Business or Enterprise plan. [View plans](https://docs.onyx.app/admins/billing/overview.md)
> or [contact sales](https://onyx.app/contact-sales) to learn more.

> [!NOTE]
>
> **Required permission:** Manage Groups (`manage:user_groups`), or Admin (`admin`).


## OpenAPI

````yaml POST /manage/admin/user-group
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/admin/user-group:
    post:
      tags:
        - public
      summary: Create User Group
      operationId: create_user_group
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    UserGroupCreate:
      properties:
        name:
          type: string
          title: Name
        user_ids:
          items:
            type: string
            format: uuid
          type: array
          title: User Ids
        cc_pair_ids:
          items:
            type: integer
          type: array
          title: Cc Pair Ids
      type: object
      required:
        - name
        - user_ids
        - cc_pair_ids
      title: UserGroupCreate
    UserGroup:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        users:
          items:
            $ref: '#/components/schemas/UserInfo'
          type: array
          title: Users
        manager_ids:
          items:
            type: string
          type: array
          title: Manager Ids
        cc_pairs:
          items:
            $ref: '#/components/schemas/ConnectorCredentialPairDescriptor'
          type: array
          title: Cc Pairs
        managed_cc_pairs:
          items:
            $ref: '#/components/schemas/ManagedCCPairEntry'
          type: array
          title: Managed Cc Pairs
        document_sets:
          items:
            $ref: '#/components/schemas/DocumentSet'
          type: array
          title: Document Sets
        personas:
          items:
            $ref: '#/components/schemas/PersonaSnapshot'
          type: array
          title: Personas
        is_up_to_date:
          type: boolean
          title: Is Up To Date
        is_up_for_deletion:
          type: boolean
          title: Is Up For Deletion
        is_default:
          type: boolean
          title: Is Default
        incognito_enabled:
          type: boolean
          title: Incognito Enabled
        permissions:
          additionalProperties:
            type: boolean
          type: object
          title: Permissions
      type: object
      required:
        - id
        - name
        - users
        - manager_ids
        - cc_pairs
        - managed_cc_pairs
        - document_sets
        - personas
        - is_up_to_date
        - is_up_for_deletion
        - is_default
        - incognito_enabled
      title: UserGroup
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
        account_type:
          $ref: '#/components/schemas/AccountType'
          default: STANDARD
        preferences:
          $ref: '#/components/schemas/UserPreferences'
        personalization:
          $ref: '#/components/schemas/UserPersonalization'
        token_expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Token Expires At
        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'
        effective_permissions:
          items:
            type: string
          type: array
          title: Effective Permissions
        is_group_manager:
          type: boolean
          title: Is Group Manager
          default: false
        admin_capabilities:
          items:
            type: string
          type: array
          title: Admin Capabilities
      type: object
      required:
        - id
        - email
        - is_active
        - is_superuser
        - is_verified
        - preferences
      title: UserInfo
    ConnectorCredentialPairDescriptor:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        connector:
          $ref: '#/components/schemas/ConnectorSnapshot'
        credential:
          $ref: '#/components/schemas/CredentialSnapshot'
        access_type:
          $ref: '#/components/schemas/AccessType'
      type: object
      required:
        - id
        - name
        - connector
        - credential
        - access_type
      title: ConnectorCredentialPairDescriptor
    ManagedCCPairEntry:
      properties:
        cc_pair_id:
          type: integer
          title: Cc Pair Id
        role:
          $ref: '#/components/schemas/ConnectorManageRole'
          default: editor
      type: object
      required:
        - cc_pair_id
      title: ManagedCCPairEntry
    DocumentSet:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        cc_pair_descriptors:
          items:
            $ref: '#/components/schemas/ConnectorCredentialPairDescriptor'
          type: array
          title: Cc Pair Descriptors
        is_up_to_date:
          type: boolean
          title: Is Up To Date
        is_public:
          type: boolean
          title: Is Public
        users:
          items:
            type: string
            format: uuid
          type: array
          title: Users
        groups:
          items:
            type: integer
          type: array
          title: Groups
        federated_connectors:
          items:
            $ref: '#/components/schemas/FederatedConnectorDescriptor'
          type: array
          title: Federated Connectors
      type: object
      required:
        - id
        - name
        - description
        - cc_pair_descriptors
        - is_up_to_date
        - is_public
        - users
        - groups
      title: DocumentSet
    PersonaSnapshot:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        is_public:
          type: boolean
          title: Is Public
        is_listed:
          type: boolean
          title: Is Listed
        uploaded_image_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Uploaded Image Id
        icon_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon Name
        user_file_ids:
          items:
            type: string
          type: array
          title: User File Ids
        display_priority:
          anyOf:
            - type: integer
            - type: 'null'
          title: Display Priority
        is_featured:
          type: boolean
          title: Is Featured
        builtin_persona:
          type: boolean
          title: Builtin Persona
        starter_messages:
          anyOf:
            - items:
                $ref: '#/components/schemas/StarterMessage'
              type: array
            - type: 'null'
          title: Starter Messages
        tools:
          items:
            $ref: '#/components/schemas/ToolSnapshot'
          type: array
          title: Tools
        labels:
          items:
            $ref: '#/components/schemas/PersonaLabelSnapshot'
          type: array
          title: Labels
        owner:
          anyOf:
            - $ref: '#/components/schemas/MinimalUserSnapshot'
            - type: 'null'
        owner_group:
          anyOf:
            - $ref: '#/components/schemas/PersonaOwnerGroupSnapshot'
            - type: 'null'
        users:
          items:
            $ref: '#/components/schemas/MinimalUserSnapshot'
          type: array
          title: Users
        groups:
          items:
            type: integer
          type: array
          title: Groups
        user_shares:
          items:
            $ref: '#/components/schemas/PersonaUserShare'
          type: array
          title: User Shares
        group_shares:
          items:
            $ref: '#/components/schemas/PersonaGroupShare'
          type: array
          title: Group Shares
        public_permission:
          $ref: '#/components/schemas/PersonaSharePermission'
        sharing_status:
          $ref: '#/components/schemas/PersonaSharingStatus'
        document_sets:
          items:
            $ref: '#/components/schemas/DocumentSetSummary'
          type: array
          title: Document Sets
        default_model_configuration_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Default Model Configuration Id
        hierarchy_nodes:
          items:
            $ref: '#/components/schemas/HierarchyNodeSnapshot'
          type: array
          title: Hierarchy Nodes
        attached_documents:
          items:
            $ref: '#/components/schemas/AttachedDocumentSnapshot'
          type: array
          title: Attached Documents
        permissions:
          additionalProperties:
            type: boolean
          type: object
          title: Permissions
        system_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: System Prompt
        replace_base_system_prompt:
          type: boolean
          title: Replace Base System Prompt
          default: false
        task_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Prompt
        datetime_aware:
          type: boolean
          title: Datetime Aware
          default: true
      type: object
      required:
        - id
        - name
        - description
        - is_public
        - is_listed
        - uploaded_image_id
        - icon_name
        - user_file_ids
        - display_priority
        - is_featured
        - builtin_persona
        - starter_messages
        - tools
        - labels
        - owner
        - owner_group
        - users
        - groups
        - user_shares
        - group_shares
        - public_permission
        - sharing_status
        - document_sets
      title: PersonaSnapshot
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AccountType:
      type: string
      enum:
        - STANDARD
        - BOT
        - EXT_PERM_USER
        - SERVICE_ACCOUNT
        - ANONYMOUS
      title: AccountType
      description: |-
        What kind of account this is — determines whether the user
        enters the group-based permission system.

        STANDARD + SERVICE_ACCOUNT → participate in group system
        BOT, EXT_PERM_USER, ANONYMOUS → fixed behavior
    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:
          items:
            type: integer
          type: array
          title: Pinned Assistants
          default: []
        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
        temperature_default:
          anyOf:
            - type: number
            - type: 'null'
          title: Temperature Default
        reasoning_effort_default:
          anyOf:
            - $ref: '#/components/schemas/ReasoningEffort'
            - type: 'null'
        theme_preference:
          anyOf:
            - $ref: '#/components/schemas/ThemePreference'
            - type: 'null'
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
        chat_background:
          anyOf:
            - type: string
            - type: 'null'
          title: Chat Background
        default_app_mode:
          $ref: '#/components/schemas/DefaultAppMode'
          default: CHAT
        paste_as_tile:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Paste As Tile
        voice_auto_send:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Voice Auto Send
        voice_auto_playback:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Voice Auto Playback
        voice_playback_speed:
          anyOf:
            - type: number
            - type: 'null'
          title: Voice Playback Speed
        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
        enable_memory_tool:
          type: boolean
          title: Enable Memory Tool
          default: true
        memories:
          items:
            $ref: '#/components/schemas/MemoryItem'
          type: array
          title: Memories
        user_preferences:
          type: string
          title: User Preferences
          default: ''
      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
    ConnectorSnapshot:
      properties:
        name:
          type: string
          title: Name
        source:
          $ref: '#/components/schemas/DocumentSource'
        input_type:
          $ref: '#/components/schemas/InputType'
        connector_specific_config:
          additionalProperties: true
          type: object
          title: Connector Specific Config
        refresh_freq:
          anyOf:
            - type: integer
            - type: 'null'
          title: Refresh Freq
        prune_freq:
          anyOf:
            - type: integer
            - type: 'null'
          title: Prune Freq
        check_freq:
          anyOf:
            - type: integer
            - type: 'null'
          title: Check Freq
        indexing_start:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Indexing Start
        id:
          type: integer
          title: Id
        credential_ids:
          items:
            type: integer
          type: array
          title: Credential Ids
        time_created:
          type: string
          format: date-time
          title: Time Created
        time_updated:
          type: string
          format: date-time
          title: Time Updated
      type: object
      required:
        - name
        - source
        - input_type
        - connector_specific_config
        - id
        - credential_ids
        - time_created
        - time_updated
      title: ConnectorSnapshot
    CredentialSnapshot:
      properties:
        credential_json:
          additionalProperties: true
          type: object
          title: Credential Json
        admin_public:
          type: boolean
          title: Admin Public
        source:
          $ref: '#/components/schemas/DocumentSource'
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        curator_public:
          type: boolean
          title: Curator Public
          default: false
        groups:
          items:
            type: integer
          type: array
          title: Groups
        id:
          type: integer
          title: Id
        user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: User Id
        user_email:
          anyOf:
            - type: string
            - type: 'null'
          title: User Email
        user_personal_name:
          anyOf:
            - type: string
            - type: 'null'
          title: User Personal Name
        time_created:
          type: string
          format: date-time
          title: Time Created
        time_updated:
          type: string
          format: date-time
          title: Time Updated
        is_owner:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Owner
      type: object
      required:
        - credential_json
        - admin_public
        - source
        - id
        - user_id
        - time_created
        - time_updated
      title: CredentialSnapshot
    AccessType:
      type: string
      enum:
        - public
        - private
        - sync
        - sync_restricted
      title: AccessType
    ConnectorManageRole:
      type: string
      enum:
        - editor
        - operator
      title: ConnectorManageRole
      description: |-
        A group's role on a cc-pair it manages. Editors change and delete the
        configuration; Operators schedule and monitor indexing.
    FederatedConnectorDescriptor:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        source:
          type: string
          title: Source
        entities:
          additionalProperties: true
          type: object
          title: Entities
      type: object
      required:
        - id
        - name
        - source
        - entities
      title: FederatedConnectorDescriptor
      description: Descriptor for a federated connector in a document set
    StarterMessage:
      properties:
        name:
          type: string
          title: Name
        message:
          type: string
          title: Message
      type: object
      required:
        - name
        - message
      title: StarterMessage
      description: Starter message for a persona.
    ToolSnapshot:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        definition:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Definition
        display_name:
          type: string
          title: Display Name
        in_code_tool_id:
          anyOf:
            - type: string
            - type: 'null'
          title: In Code Tool Id
        custom_headers:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Custom Headers
        passthrough_auth:
          type: boolean
          title: Passthrough Auth
        mcp_server_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Mcp Server Id
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        oauth_config_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Oauth Config Id
        oauth_config_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Oauth Config Name
        enabled:
          type: boolean
          title: Enabled
          default: true
        user_enabled_in_chat:
          type: boolean
          title: User Enabled In Chat
          default: true
        default_chat_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Default Chat Enabled
          description: Whether this tool is selected for the default assistant.
        permissions:
          additionalProperties:
            type: boolean
          type: object
          title: Permissions
        chat_selectable:
          type: boolean
          title: Chat Selectable
          default: true
        agent_creation_selectable:
          type: boolean
          title: Agent Creation Selectable
          default: true
        default_enabled:
          type: boolean
          title: Default Enabled
          default: false
      type: object
      required:
        - id
        - name
        - description
        - definition
        - display_name
        - in_code_tool_id
        - custom_headers
        - passthrough_auth
      title: ToolSnapshot
    PersonaLabelSnapshot:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: PersonaLabelSnapshot
    MinimalUserSnapshot:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
      type: object
      required:
        - id
        - email
      title: MinimalUserSnapshot
    PersonaOwnerGroupSnapshot:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: PersonaOwnerGroupSnapshot
    PersonaUserShare:
      properties:
        user:
          $ref: '#/components/schemas/MinimalUserSnapshot'
        permission:
          $ref: '#/components/schemas/PersonaSharePermission'
      type: object
      required:
        - user
        - permission
      title: PersonaUserShare
    PersonaGroupShare:
      properties:
        group_id:
          type: integer
          title: Group Id
        group_name:
          type: string
          title: Group Name
        permission:
          $ref: '#/components/schemas/PersonaSharePermission'
      type: object
      required:
        - group_id
        - group_name
        - permission
      title: PersonaGroupShare
    PersonaSharePermission:
      type: string
      enum:
        - EDITOR
        - VIEWER
      title: PersonaSharePermission
      description: |-
        Level granted by a persona share row (user or group), or to the whole
        org via `Persona.public_permission`.
    PersonaSharingStatus:
      type: string
      enum:
        - PRIVATE
        - SHARED
        - PUBLIC
      title: PersonaSharingStatus
      description: |-
        Derived share state computed from a persona's columns by the sharing
        helpers (no DB column of its own): group-owned or row-shared counts as
        SHARED even with an empty share list; PUBLIC wins over both.
    DocumentSetSummary:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        cc_pair_summaries:
          items:
            $ref: '#/components/schemas/CCPairSummary'
          type: array
          title: Cc Pair Summaries
        is_up_to_date:
          type: boolean
          title: Is Up To Date
        is_public:
          type: boolean
          title: Is Public
        users:
          items:
            type: string
            format: uuid
          type: array
          title: Users
        groups:
          items:
            type: integer
          type: array
          title: Groups
        permissions:
          additionalProperties:
            type: boolean
          type: object
          title: Permissions
        federated_connector_summaries:
          items:
            $ref: '#/components/schemas/FederatedConnectorSummary'
          type: array
          title: Federated Connector Summaries
      type: object
      required:
        - id
        - name
        - description
        - cc_pair_summaries
        - is_up_to_date
        - is_public
        - users
        - groups
      title: DocumentSetSummary
      description: Simplified document set model with minimal data for list views
    HierarchyNodeSnapshot:
      properties:
        id:
          type: integer
          title: Id
        raw_node_id:
          type: string
          title: Raw Node Id
        display_name:
          type: string
          title: Display Name
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
        source:
          $ref: '#/components/schemas/DocumentSource'
        node_type:
          $ref: '#/components/schemas/HierarchyNodeType'
      type: object
      required:
        - id
        - raw_node_id
        - display_name
        - link
        - source
        - node_type
      title: HierarchyNodeSnapshot
      description: Minimal representation of a hierarchy node for persona responses.
    AttachedDocumentSnapshot:
      properties:
        id:
          type: string
          title: Id
        title:
          type: string
          title: Title
        link:
          anyOf:
            - type: string
            - type: 'null'
          title: Link
        parent_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Parent Id
        last_modified:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Modified
        last_synced:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Synced
        source:
          anyOf:
            - $ref: '#/components/schemas/DocumentSource'
            - type: 'null'
      type: object
      required:
        - id
        - title
        - link
        - parent_id
        - last_modified
        - last_synced
        - source
      title: AttachedDocumentSnapshot
      description: Minimal representation of an attached document for persona responses.
    ReasoningEffort:
      type: string
      enum:
        - auto
        - 'off'
        - low
        - medium
        - high
        - xhigh
      title: ReasoningEffort
      description: >-
        Reasoning effort levels for models that support extended thinking.


        Different providers map these values differently:

        - OpenAI: Uses "low", "medium", "high" directly for reasoning_effort.
        Recently added "none" for 5 series
                  which is like "minimal"
        - Claude: Uses budget_tokens with different values for each level

        - Gemini: Uses "none", "low", "medium", "high" for thinking_budget (via
        litellm mapping)
    ThemePreference:
      type: string
      enum:
        - light
        - dark
        - system
      title: ThemePreference
    DefaultAppMode:
      type: string
      enum:
        - AUTO
        - CHAT
        - SEARCH
      title: DefaultAppMode
    UserSpecificAssistantPreference:
      properties:
        disabled_tool_ids:
          items:
            type: integer
          type: array
          title: Disabled Tool Ids
      type: object
      required:
        - disabled_tool_ids
      title: UserSpecificAssistantPreference
    MemoryItem:
      properties:
        id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Id
        content:
          type: string
          title: Content
      type: object
      required:
        - content
      title: MemoryItem
    TenantSnapshot:
      properties:
        number_of_users:
          type: integer
          title: Number Of Users
      type: object
      required:
        - number_of_users
      title: TenantSnapshot
    DocumentSource:
      type: string
      enum:
        - ingestion_api
        - slack
        - web
        - google_drive
        - gmail
        - github
        - gitbook
        - gitlab
        - guru
        - bookstack
        - outline
        - confluence
        - jira
        - slab
        - productboard
        - file
        - coda
        - canvas
        - notion
        - zulip
        - linear
        - hubspot
        - document360
        - gong
        - google_sites
        - zendesk
        - loopio
        - box
        - dropbox
        - sharepoint
        - onedrive
        - teams
        - outlook
        - salesforce
        - discourse
        - axero
        - clickup
        - mediawiki
        - wikipedia
        - asana
        - s3
        - r2
        - google_cloud_storage
        - oci_storage
        - xenforo
        - not_applicable
        - discord
        - freshdesk
        - fireflies
        - zoom
        - egnyte
        - airtable
        - highspot
        - drupal_wiki
        - imap
        - bitbucket
        - testrail
        - braintrust
        - lumapps
        - youtrack
        - mock_connector
        - user_file
        - craft_file
      title: DocumentSource
    InputType:
      type: string
      enum:
        - load_state
        - poll
        - event
        - slim_retrieval
      title: InputType
    CCPairSummary:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        source:
          $ref: '#/components/schemas/DocumentSource'
        access_type:
          $ref: '#/components/schemas/AccessType'
      type: object
      required:
        - id
        - name
        - source
        - access_type
      title: CCPairSummary
      description: >-
        Simplified connector-credential pair information with just essential
        data
    FederatedConnectorSummary:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        source:
          $ref: '#/components/schemas/FederatedConnectorSource'
        entities:
          additionalProperties: true
          type: object
          title: Entities
      type: object
      required:
        - id
        - name
        - source
        - entities
      title: FederatedConnectorSummary
      description: Simplified federated connector information with just essential data
    HierarchyNodeType:
      type: string
      enum:
        - folder
        - source
        - stub
        - shared_drive
        - my_drive
        - space
        - page
        - project
        - database
        - workspace
        - site
        - drive
        - channel
        - mailbox
      title: HierarchyNodeType
      description: Types of hierarchy nodes across different sources
    FederatedConnectorSource:
      type: string
      enum:
        - federated_slack
      title: FederatedConnectorSource
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authorization header with Bearer token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.