Altimate AI USER_GROUP API

openapi: 3.1.0
info:
  title: Fast ACCOUNT_COSTS USER_GROUP API
  version: 0.1.0
tags:
- name: USER_GROUP
paths:
  /groups/:
    get:
      tags:
      - USER_GROUP
      summary: Group Get All
      operationId: group_get_all_groups__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Search
      - name: sortOrder
        in: query
        required: false
        schema:
          type: string
          default: asc
          title: Sortorder
      - name: sortColumn
        in: query
        required: false
        schema:
          type: string
          default: name
          title: Sortcolumn
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Date
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_GroupSummaryResponse_'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Get All Groups  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Get All Groups  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - USER_GROUP
      summary: Group Add
      operationId: group_add_groups__post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupAddIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Add Groups  Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Add Groups  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/get_all:
    get:
      tags:
      - USER_GROUP
      summary: Group Get All Unpaginated
      operationId: group_get_all_unpaginated_groups_get_all_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Search
      - name: sortOrder
        in: query
        required: false
        schema:
          type: string
          default: asc
          title: Sortorder
      - name: sortColumn
        in: query
        required: false
        schema:
          type: string
          default: name
          title: Sortcolumn
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Date
      - name: navigationSource
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Navigationsource
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GroupSummaryResponse'
                title: Response Group Get All Unpaginated Groups Get All Get
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Get All Unpaginated Groups Get All Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Get All Unpaginated Groups Get All Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{group_id}:
    get:
      tags:
      - USER_GROUP
      summary: Group Get One
      operationId: group_get_one_groups__group_id__get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
          title: Group Id
      - name: start_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: End Date
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Get One Groups  Group Id  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Get One Groups  Group Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - USER_GROUP
      summary: Group Edit
      operationId: group_edit_groups__group_id__patch
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
          title: Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupEditIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Edit Groups  Group Id  Patch
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Edit Groups  Group Id  Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - USER_GROUP
      summary: Group Delete
      operationId: group_delete_groups__group_id__delete
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
          title: Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Delete Groups  Group Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Delete Groups  Group Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{group_id}/rules/{rule_id}:
    delete:
      tags:
      - USER_GROUP
      summary: Group Rule Delete
      operationId: group_rule_delete_groups__group_id__rules__rule_id__delete
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
          title: Group Id
      - name: rule_id
        in: path
        required: true
        schema:
          type: integer
          title: Rule Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Rule Delete Groups  Group Id  Rules  Rule Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Rule Delete Groups  Group Id  Rules  Rule Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/group_rule_file:
    post:
      tags:
      - USER_GROUP
      summary: Upload File
      operationId: upload_file_groups_group_rule_file_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_file_groups_group_rule_file_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Upload File Groups Group Rule File Post
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Upload File Groups Group Rule File Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Upload File Groups Group Rule File Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/user_group_file:
    post:
      tags:
      - USER_GROUP
      summary: Upload File
      operationId: upload_file_groups_user_group_file_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_file_groups_user_group_file_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Upload File Groups User Group File Post
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Upload File Groups User Group File Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Upload File Groups User Group File Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/group_rules/{group_uuid}:
    get:
      tags:
      - USER_GROUP
      summary: Upload File
      operationId: upload_file_groups_group_rules__group_uuid__get
      deprecated: true
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_uuid
        in: path
        required: true
        schema:
          title: Group Uuid
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Upload File Groups Group Rules  Group Uuid  Get
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Upload File Groups Group Rules  Group Uuid  Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Upload File Groups Group Rules  Group Uuid  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{group_id}/users/{user_id}:
    delete:
      tags:
      - USER_GROUP
      summary: Group User Remove
      operationId: group_user_remove_groups__group_id__users__user_id__delete
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: integer
          title: Group Id
      - name: user_id
        in: path
        required: true
        schema:
          type: integer
          title: User Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group User Remove Groups  Group Id  Users  User Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group User Remove Groups  Group Id  Users  User Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/group_create:
    post:
      tags:
      - USER_GROUP
      summary: Group Create
      operationId: group_create_groups_group_create_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Group Create Groups Group Create Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Group Create Groups Group Create Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{user_group_id}/rules:
    post:
      tags:
      - USER_GROUP
      summary: Add Group Rule
      operationId: add_group_rule_groups__user_group_id__rules_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: user_group_id
        in: path
        required: true
        schema:
          type: integer
          title: User Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupRuleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Add Group Rule Groups  User Group Id  Rules Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Add Group Rule Groups  User Group Id  Rules Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{user_group_id}/members:
    post:
      tags:
      - USER_GROUP
      summary: Add Group Member
      operationId: add_group_member_groups__user_group_id__members_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: user_group_id
        in: path
        required: true
        schema:
          type: integer
          title: User Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMemberRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Add Group Member Groups  User Group Id  Members Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Add Group Member Groups  User Group Id  Members Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{user_group_id}/ownership:
    post:
      tags:
      - USER_GROUP
      summary: Add Group Ownership
      operationId: add_group_ownership_groups__user_group_id__ownership_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: user_group_id
        in: path
        required: true
        schema:
          type: integer
          title: User Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupOwnershipRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Add Group Ownership Groups  User Group Id  Ownership Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Add Group Ownership Groups  User Group Id  Ownership Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - USER_GROUP
      summary: Get Group Ownership
      operationId: get_group_ownership_groups__user_group_id__ownership_get
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: user_group_id
        in: path
        required: true
        schema:
          type: integer
          title: User Group Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response Get Group Ownership Groups  User Group Id  Ownership Get
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Group Ownership Groups  User Group Id  Ownership Get
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Group Ownership Groups  User Group Id  Ownership Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/{user_group_id}/ownership/{ownership_id}:
    delete:
      tags:
      - USER_GROUP
      summary: Delete Group Ownership
      operationId: delete_group_ownership_groups__user_group_id__ownership__ownership_id__delete
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: user_group_id
        in: path
        required: true
        schema:
          type: integer
          title: User Group Id
      - name: ownership_id
        in: path
        required: true
        schema:
          type: integer
          title: Ownership Id
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Delete Group Ownership Groups  User Group Id  Ownership  Ownership Id  Delete
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Delete Group Ownership Groups  User Group Id  Ownership  Ownership Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/ownership-rules/cost-preview:
    post:
      tags:
      - USER_GROUP
      summary: Get Ownership Cost Preview
      description: 'Calculate cost preview based on ownership rules.


        This endpoint allows you to preview the cost impact of ownership rules

        without actually creating them in a group.'
      operationId: get_ownership_cost_preview_groups_ownership_rules_cost_preview_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: false
        schema:
          type: string
          format: date-time
          title: Start Date
      - name: end_date
        in: query
        required: false
        schema:
          type: string
          format: date-time
          title: End Date
      - name: x-tenant
        in: header
        required: true
        schema:
          type: string
          title: X-Tenant
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OwnershipCostPreviewRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OwnershipCostPreviewResponse'
        '400':
          description: Invalid data
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 400 Get Ownership Cost Preview Groups Ownership Rules Cost Preview Post
        '403':
          description: Not supported for public user
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response 403 Get Ownership Cost Preview Groups Ownership Rules Cost Preview Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /groups/ownership-rules/conflicting-team:
    post:
      tags:
      - USER_GROUP
      summary: Get Conflicting Team
      description: "Get conflicting teams with pagination and ordering by conflicting cost descending.\n\nArgs:\n    cost_preview_data: Ownership cost preview request with entity type and ownership rules\n    start_date: Start date for filtering\n    end_date: End date for filtering\n    limit: Maximum number of results to return (default: 100, max: 1000)\n    offset: Offset for pagination (default: 0)\n\nReturns:\n    OwnershipConflictingTeamResponse with list of conflicts and currency"
      operationId: get_conflicting_team_groups_ownership_rules_conflicting_team_post
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      parameters:
      - name: start_date
        in: query
        required: false
        schema:
          type: string
          format: date-time
          title: Start Date
      - name: e

# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/altimate-ai/refs/heads/main/openapi/altimate-ai-user-group-api-openapi.yml