openapi: 3.0.3
info:
  title: Activiti Public Rest About Admin Tenants API
  description: " The Alfresco Activiti BPM Suite comes with a REST API. It includes both an Enterprise equivalent of the Activiti Open Source REST API exposing the generic Activiti Engine operations, and a dedicated set op REST API endpoints specific for the functionality in the Alfresco Activiti BPM Suite. \n      Note that there is also an 'internal' REST API, which are the REST endpoints used by the Javascript UI. It is advised not to use this API, these REST API urls and way of using it will change and evolve with the product and are unsupported. The supported API is stable. Also, the internal REST API uses a different authentication mechanism tailored towards web browser usage.\n"
  version: 1.4.0
  contact:
    name: Activiti Community
    url: https://www.activiti.org/
    email: activiti-community@alfresco.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{host}/activiti-app
  description: Activiti BPM Server
  variables:
    host:
      default: localhost:8080
      description: The Activiti server host
security:
- basicAuth: []
tags:
- name: Admin Tenants
  description: Manage Tenants
paths:
  /api/enterprise/admin/tenants:
    get:
      tags:
      - Admin Tenants
      summary: Get all tenants
      description: Tenant manager only
      operationId: getTenantsUsingGET_1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LightTenantRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Admin Tenants
      summary: Create a new tenant
      description: Tenant manager only
      operationId: createTenantUsingPOST_1
      requestBody:
        description: createTenantRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTenantRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LightTenantRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/admin/tenants/{tenantId}:
    get:
      tags:
      - Admin Tenants
      summary: Get tenant details
      operationId: getTenantUsingGET_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantRepresentation'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Admin Tenants
      summary: Update a tenant
      operationId: updateUsingPUT_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        description: createTenantRepresentation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTenantRepresentation'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    delete:
      tags:
      - Admin Tenants
      summary: Delete a tenant
      operationId: deleteTenantUsingDELETE_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /api/enterprise/admin/tenants/{tenantId}/events:
    get:
      tags:
      - Admin Tenants
      summary: Get tenant events
      operationId: getTenantEventsUsingGET_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TenantEvent'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/enterprise/admin/tenants/{tenantId}/logo:
    get:
      tags:
      - Admin Tenants
      summary: Get tenant logo
      operationId: getTenantLogoUsingGET_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    post:
      tags:
      - Admin Tenants
      summary: Update tenant logo
      operationId: uploadTenantLogoUsingPOST_1
      parameters:
      - name: tenantId
        in: path
        description: tenantId
        required: true
        schema:
          type: integer
          format: int64
      - name: file
        in: formData
        description: file
        required: true
        schema:
          type: file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageUploadRepresentation'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    CreateTenantRepresentation:
      properties:
        active:
          type: boolean
        domain:
          type: string
        maxUsers:
          type: integer
          format: int32
        name:
          type: string
    TenantEvent:
      properties:
        eventTime:
          type: string
          format: date-time
        eventType:
          type: string
        extraInfo:
          type: string
        id:
          type: integer
          format: int64
        tenantId:
          type: integer
          format: int64
        userId:
          type: integer
          format: int64
        userName:
          type: string
    ImageUploadRepresentation:
      properties:
        created:
          type: string
          format: date-time
        id:
          type: integer
          format: int64
        name:
          type: string
        userId:
          type: integer
          format: int64
    TenantRepresentation:
      properties:
        active:
          type: boolean
        created:
          type: string
          format: date-time
        domain:
          type: string
        id:
          type: integer
          format: int64
        lastUpdate:
          type: string
          format: date-time
        logoId:
          type: integer
          format: int64
        maxUsers:
          type: integer
          format: int32
        name:
          type: string
    LightTenantRepresentation:
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using valid Activiti user credentials