openapi: 3.1.0
info:
  title: Configure8 Public REST Catalog Entities Users API
  version: v1
  description: Best-effort OpenAPI 3.1 description of the Configure8 public REST API, derived from the published API reference at https://docs.configure8.io/ and https://configure8.readme.io/reference. Covers catalog entities, catalog relations, scorecards, users, and related Internal Developer Portal operations. Endpoint paths and request shapes follow Configure8's documented `/public/v1` surface.
  contact:
    name: Configure8 Documentation
    url: https://docs.configure8.io/
servers:
- url: https://{tenant}.configure8.io/public/v1
  description: Configure8 SaaS tenant
  variables:
    tenant:
      default: app
      description: Configure8 tenant subdomain
security:
- apiKey: []
tags:
- name: Users
paths:
  /users:
    get:
      tags:
      - Users
      summary: Retrieve users
      operationId: listUsers
      parameters:
      - name: email
        in: query
        schema:
          type: string
      - name: role
        in: query
        schema:
          type: string
      responses:
        '200':
          description: User list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
  /users/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      tags:
      - Users
      summary: Modify a user
      operationId: updateUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: Updated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
    delete:
      tags:
      - Users
      summary: Remove a user
      operationId: deleteUser
      responses:
        '204':
          description: Deleted
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        name:
          type: string
        role:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: Bearer/API token issued from the Configure8 UI; passed in the Authorization header