openapi: 3.2.0
info:
  title: Aembit Cloud Client Workload API
  version: v1
servers:
- url: https://{tenant}.aembit.io
  variables:
    tenant:
      default: tenant
      description: Aembit Tenant ID
security:
- {}
tags:
- name: Client Workload
paths:
  /api/v1/client-workloads:
    post:
      tags:
      - Client Workload
      summary: Create a Client Workload
      description: Create a Client Workload.
      operationId: post-client-workload
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadExternalDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      responses:
        '204':
          description: Created Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    put:
      tags:
      - Client Workload
      summary: Update a Client Workload
      description: Update a Client Workload.
      operationId: put-client-workload
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadExternalDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      responses:
        '200':
          description: Updated Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    get:
      tags:
      - Client Workload
      summary: Get a page of Client Workloads
      description: Get a page of Client Workloads.
      operationId: get-client-workloads
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: per-page
        in: query
        schema:
          type: integer
          format: int32
          default: 100
      - name: filter
        in: query
        schema:
          type: string
          default: ''
      - name: order
        in: query
        schema:
          type: string
          default: ''
      - name: group-by
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Page of Client Workloads
          content:
            application/json:
              schema:
                description: Page of Client Workloads
                $ref: '#/components/schemas/ClientWorkloadListDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
  /api/v1/client-workloads/{id}:
    patch:
      tags:
      - Client Workload
      summary: Patch a Client Workload
      description: Patch a Client Workload.
      operationId: patch-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadPatchDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadPatchDTO'
      responses:
        '200':
          description: Patched Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    get:
      tags:
      - Client Workload
      summary: Get a Client Workload
      description: Get a Client Workload identified by its ID.
      operationId: get-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '204':
          description: Client Workload Not Found
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    delete:
      tags:
      - Client Workload
      summary: Delete a Client Workload
      description: Delete a Client Workload identified by its ID.
      operationId: delete-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successfully deleted Client Workload
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
  /api/v1/client-workloads/identifiers:
    get:
      tags:
      - Client Workload
      summary: Get Client Identifier List
      description: Get list of client identifier objects
      operationId: get-client-identifiers
      responses:
        '200':
          description: Client Identifiers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientIdentifierExternalDTO'
        '204':
          description: Client Identifiers Not Found
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
components:
  schemas:
    ClientIdentifierExternalDTO:
      type: object
      properties:
        name:
          type:
          - 'null'
          - string
        displayName:
          type:
          - 'null'
          - string
        environmentPath:
          type:
          - 'null'
          - string
        isSupported:
          type: boolean
      additionalProperties: false
    ClientWorkloadIdentityDTO:
      required:
      - value
      type: object
      properties:
        type:
          maxLength: 255
          type:
          - 'null'
          - string
        value:
          minLength: 1
          type: string
        key:
          maxLength: 255
          type:
          - 'null'
          - string
      additionalProperties: false
    TagDTO:
      required:
      - key
      - value
      type: object
      properties:
        key:
          minLength: 1
          type: string
          description: Tag Key
        value:
          minLength: 1
          type: string
          description: Tag Key Value
      additionalProperties: false
      description: Aembit Entity Tag Details
    ClientWorkloadExternalDTO:
      required:
      - isActive
      - name
      - resourceSet
      type: object
      properties:
        externalId:
          type: string
          format: uuid
        name:
          maxLength: 128
          minLength: 1
          type: string
          description: Name of the Entity
        description:
          type:
          - 'null'
          - string
          description: Description of the Entity
        isActive:
          type: boolean
          description: True/False value that determines if this entity is Active or Disabled
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type:
          - 'null'
          - string
          format: date-time
        createdBy:
          type:
          - 'null'
          - string
        modifiedBy:
          type:
          - 'null'
          - string
        resourceSet:
          type: string
          description: ID of the Resource Set in which this Access Entity exists
          format: uuid
        identities:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadIdentityDTO'
        standaloneCertificateAuthority:
          type:
          - 'null'
          - string
          description: Standalone Certificate Authority associated with this Client Workload
          format: uuid
        enforceSso:
          type: boolean
          description: Whether SSO is enforced for MCP authorization
        type:
          type:
          - 'null'
          - string
        accessPolicyCount:
          type: integer
          description: Access Policies associated with this Client Workload
          format: int32
        ssoIdentityProviders:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
      additionalProperties: false
    GenericResponseDTO:
      type: object
      properties:
        success:
          type: boolean
          description: True if the API call was successful, False otherwise
        message:
          type:
          - 'null'
          - string
          description: Message to indicate why the API call failed
        id:
          type: integer
          description: Unique identifier of the API response
          format: int32
      additionalProperties: false
      description: DTO for a Generic API Response
    ClientWorkloadPatchDTO:
      type: object
      properties:
        name:
          maxLength: 128
          type:
          - 'null'
          - string
          description: New Name for the identified entity
        description:
          type:
          - 'null'
          - string
          description: New Description for the identified entity
        isActive:
          type:
          - 'null'
          - boolean
          description: New Status for the identified entity
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
          description: New Tags for the identified entity
        identities:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadIdentityDTO'
      additionalProperties: false
    ClientWorkloadListDTO:
      type: object
      properties:
        page:
          type: integer
          description: Page of entities
          format: int32
        perPage:
          type: integer
          description: Number of entities requested for the current page
          format: int32
        order:
          type:
          - 'null'
          - string
          description: Ordering criteria used for the current page
        statusCode:
          type: integer
          format: int32
        recordsTotal:
          type: integer
          format: int32
        clientWorkloads:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      additionalProperties: false
      description: Page of Client Workloads
  securitySchemes:
    bearerAuth:
      type: http
      description: Authorization header using the Bearer scheme.
      scheme: bearer
      bearerFormat: Reference