Apache OpenMeetings GroupService API

openapi: 3.0.1
info:
  title: Apache OpenMeetings REST CalendarService GroupService API
  description: The OpenMeetings REST API provides endpoints for managing rooms, users, recordings, calendars, file uploads, whiteboards, and groups. It supports SOAP API for legacy integrations and plugin APIs for LMS integration.
  version: 9.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://openmeetings.apache.org/
servers:
- url: https://{host}:5443/openmeetings/services
  description: Apache OpenMeetings REST API server
  variables:
    host:
      default: localhost
tags:
- name: GroupService
paths:
  /group:
    get:
      tags:
      - GroupService
      description: Get the list of all groups
      operationId: get_1
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      responses:
        '200':
          description: list of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupDTOListWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings Get_1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - GroupService
      description: add a new group
      operationId: add_1
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: name
        in: query
        description: The name of the group
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ServiceResult with result type, and id of the group added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings Add_1
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /group/{id}/rooms/add/{roomid}:
    post:
      tags:
      - GroupService
      description: Adds a room to an group
      operationId: addRoom
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Id of group that the room is being paired with
        required: true
        schema:
          type: integer
          format: int64
      - name: roomid
        in: path
        description: Id of room to be added
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ServiceResult with result type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings AddRoom
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /group/{id}/users/{userid}:
    post:
      tags:
      - GroupService
      description: Add USER to a certain group
      operationId: addUser
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: the USER id
        required: true
        schema:
          type: integer
          format: int64
      - name: userid
        in: path
        description: the group id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ServiceResult with result type, and id of the USER added, or error id in case of the error as text
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings AddUser
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - GroupService
      description: Remove USER from a certain group
      operationId: removeUser
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: the USER id
        required: true
        schema:
          type: integer
          format: int64
      - name: userid
        in: path
        description: the group id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ServiceResult with result type, and id of the USER removed, or error id in case of the error as text
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings RemoveUser
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /group/{id}:
    delete:
      tags:
      - GroupService
      description: Deletes a group
      operationId: delete_2
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: the id of the group
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: ServiceResult with result type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings Delete_2
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /group/users/{id}:
    get:
      tags:
      - GroupService
      description: Search users and return them
      operationId: getUsers
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: the group id
        required: true
        schema:
          type: integer
          format: int64
      - name: start
        in: query
        description: first record
        required: true
        schema:
          type: integer
          format: int32
      - name: max
        in: query
        description: max records
        required: true
        schema:
          type: integer
          format: int32
      - name: orderby
        in: query
        description: orderby clause
        required: true
        schema:
          type: string
      - name: asc
        in: query
        description: asc or desc
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: users found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSearchResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings GetUsers
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GroupDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    ServiceResultWrapper:
      type: object
      properties:
        serviceResult:
          $ref: '#/components/schemas/ServiceResult'
      example:
        serviceResult:
          message: 9dbb6907-61fc-42c0-a2b2-5dbfbe053ac6
          type: SUCCESS
    UserDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        login:
          type: string
        password:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        rights:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
            - ADMIN
            - GROUP_ADMIN
            - ADMIN_CONFIG
            - ADMIN_CONNECTIONS
            - ADMIN_BACKUP
            - ADMIN_LABEL
            - ROOM
            - DASHBOARD
            - LOGIN
            - SOAP
        languageId:
          type: integer
          format: int64
        address:
          $ref: '#/components/schemas/Address'
        timeZoneId:
          type: string
        externalId:
          type: string
        externalType:
          type: string
        pictureUri:
          type: string
        type:
          type: string
          enum:
          - USER
          - LDAP
          - OAUTH
          - EXTERNAL
          - CONTACT
    Address:
      type: object
      properties:
        inserted:
          type: string
          format: date-time
          xml:
            name: created
        updated:
          type: string
          format: date-time
        deleted:
          type: boolean
        id:
          type: integer
          format: int64
        additionalname:
          type: string
        comment:
          type: string
        fax:
          type: string
        country:
          type: string
        street:
          type: string
        town:
          type: string
        zip:
          type: string
        email:
          type: string
          xml:
            name: mail
        phone:
          type: string
      xml:
        name: address
    ServiceResult:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
    GroupDTOListWrapper:
      type: object
      properties:
        groupDTO:
          type: array
          items:
            $ref: '#/components/schemas/GroupDTO'
      example:
        groupDTO:
        - id: 1
          name: admin
        - id: 2
          name: myCMS
    UserSearchResult:
      type: object
      properties:
        objectName:
          type: string
        records:
          type: integer
          format: int64
        result:
          type: array
          items:
            $ref: '#/components/schemas/UserDTO'
        errorKey:
          type: string
    UserSearchResultWrapper:
      type: object
      properties:
        userSearchResult:
          $ref: '#/components/schemas/UserSearchResult'
      example:
        userSearchResult:
          objectName: org.apache.openmeetings.db.entity.user.User
          records: 2
          result:
          - address:
              created: 1631958373000
              deleted: false
              country: NZ
              mail: test@test.com
            id: 3
            languageId: 1
            login: soapuser
            rights:
            - ROOM
            - SOAP
            - DASHBOARD
            - ADMIN
            - LOGIN
            timeZoneId: Europe/Berlin
            type: USER
          - address:
              created: 1630191589000
              deleted: false
              country: NZ
              mail: seba.wagner@gmail.com
            firstname: firstname
            id: 1
            languageId: 1
            lastname: lastname
            login: admin
            rights:
            - ROOM
            - SOAP
            - DASHBOARD
            - ADMIN
            - LOGIN
            timeZoneId: Europe/Berlin
            type: USER