Uniform Teams API

openapi: 3.0.3
info:
  title: Uniform Platform Aggregates Teams API
  version: '2.0'
tags:
- name: Teams
paths:
  /api/v1/team:
    delete:
      description: Delete a team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                teamId:
                  type: string
              required:
              - teamId
              additionalProperties: false
      responses:
        '204':
          description: Team deleted successfully
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          description: Team not found
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Teams
      security:
      - BearerAuth: []
    post:
      description: Create a new team
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                e2eOnlyEntitlements:
                  type: array
                  items:
                    type: object
                    properties:
                      entitlement_id:
                        type: string
                        minLength: 1
                      quantity:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                    - entitlement_id
                    - quantity
                    additionalProperties: false
                  deprecated: true
                  description: Internal use only. Ignored in public requests.
              required:
              - name
              additionalProperties: false
      responses:
        '200':
          description: Team created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  ident:
                    type: array
                    items:
                      type: object
                      properties:
                        identity:
                          type: object
                          properties:
                            name:
                              type: string
                            email_address:
                              type: string
                              nullable: true
                          required:
                          - name
                          - email_address
                          additionalProperties: false
                      required:
                      - identity
                      additionalProperties: false
                required:
                - id
                - name
                - ident
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Teams
      security:
      - BearerAuth: []
    patch:
      description: Update team name and/or LLM configuration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                teamId:
                  type: string
                  description: The ID of the team to update
                name:
                  type: string
                  minLength: 1
                  description: The new name of the team. If not provided, the team name will not be updated.
                llmConfig:
                  oneOf:
                  - type: object
                    properties:
                      provider:
                        type: string
                        enum:
                        - openai
                      apiKey:
                        type: string
                      baseUrl:
                        type: string
                        format: uri
                        description: Custom base URL for OpenAI API (e.g., for Azure OpenAI)
                    required:
                    - provider
                    - apiKey
                  - type: object
                    properties:
                      provider:
                        type: string
                        enum:
                        - azure-openai
                      apiKey:
                        type: string
                      baseUrl:
                        type: string
                        format: uri
                        description: Azure OpenAI base URL
                      smallModelDeploymentName:
                        type: string
                        description: Deployment name for small model in Azure
                      largeModelDeploymentName:
                        type: string
                        description: Deployment name for large model in Azure
                    required:
                    - provider
                    - apiKey
                    - baseUrl
                    - smallModelDeploymentName
                    - largeModelDeploymentName
                  - type: object
                    properties:
                      provider:
                        type: string
                        enum:
                        - anthropic
                      apiKey:
                        type: string
                    required:
                    - provider
                    - apiKey
                  - nullable: true
                  description: The new LLM configuration for the team. Pass null to clear existing configuration. If not provided, the LLM configuration will not be updated.
                  deprecated: true
              required:
              - teamId
              additionalProperties: false
      responses:
        '204':
          description: Team updated successfully
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - Teams
      security:
      - BearerAuth: []
components:
  responses:
    ForbiddenError:
      description: Permission was denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitError:
      description: Too many requests in allowed time period
    BadRequestError:
      description: Request input validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Execution error occurred
    UnauthorizedError:
      description: API key or token was not valid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        errorMessage:
          description: Error message(s) that occurred while processing the request
          oneOf:
          - type: array
            items:
              type: string
          - type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer