Flowable Accounts API

openapi: 3.0.0
info:
  description: "# flowable / flowəb(ə)l /\r\n\r\n- a compact and highly efficient workflow and Business Process Management (BPM) platform for developers, system admins and business users.\r\n- a lightning fast, tried and tested BPMN 2 process engine written in Java. It is Apache 2.0 licensed open source, with a committed community.\r\n- can run embedded in a Java application, or as a service on a server, a cluster, and in the cloud. It integrates perfectly with Spring. With a rich Java and REST API, it is the ideal engine for orchestrating human or system activities."
  version: v1
  title: Flowable REST Access Tokens Accounts API
  contact:
    name: Flowable
    url: http://www.flowable.org/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: /flowable-rest/service
tags:
- name: Accounts
paths:
  /users/{userId}/accounts:
    get:
      tags:
      - Accounts
      summary: List user accounts
      description: ''
      operationId: listUserAccounts
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: order
        in: query
        description: From the paginate request.  The sort order, either 'asc' or 'desc'. Defaults to 'asc'.
        required: false
        schema:
          type: string
      - name: size
        in: query
        description: From the paginate request. Number of rows to fetch, starting from start. Defaults to 10.
        required: false
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: Property to sort the results on
        required: false
        schema:
          type: string
      - name: start
        in: query
        description: From the paginate request. Index of the first row to fetch. Defaults to 0.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Indicates the request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataResponseUserAccountResponse'
        '400':
          description: Indicates the request body is incomplete or contains illegal values.
        '403':
          description: Indicates the user does not have the rights to view the users.
      security:
      - basicAuth: []
components:
  schemas:
    DataResponseUserAccountResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserAccountResponse'
        total:
          type: integer
          format: int64
        start:
          type: integer
          format: int32
        sort:
          type: string
        order:
          type: string
        size:
          type: integer
          format: int32
    UserAccountResponse:
      type: object
      required:
      - creationTime
      - id
      - state
      - subState
      - subType
      - type
      properties:
        id:
          type: string
          description: The unique id for the user account
        userId:
          type: string
          description: The id of the user that this account belongs to
        tenantId:
          type: string
          description: The id of the tenant that this user account belongs to
        name:
          type: string
          description: Readable name of the account
        type:
          type: string
          example: default, messenger
          description: The type of the account
        subType:
          type: string
          example: Facebook, WeChat, WhatsApp, Telegram, LINE
          description: The sub-type of the account
        state:
          type: string
          description: The state of the user account
        subState:
          type: string
          description: The sub state of the user account
        businessAccountId:
          type: string
          example: WhatsApp business number xyz or WeChat official account
          description: The id of the business account id this user account is linked to
        externalUserId:
          type: string
          example: The phone number if it is a WhatsApp account or the user-id for a facebook account, etc)
          description: The id of the user within the external system
        userAccountDefinitionId:
          type: string
          description: The id of the user account definition for this user account
        creatorId:
          type: string
          description: The id of the user that created this account
        creationTime:
          type: string
          description: The time of creation of this account
        updaterId:
          type: string
          description: The id of the user that last updated the account
        updateTime:
          type: string
          description: The time of the last update of this account
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic