Avaya Group Management API

openapi: 3.2.0
info:
  title: Admin - Group Group Management API
  description: Group management APIs are used to create the group of different resources like user.
  contact:
    name: Avaya API Team
    url: https://developers.avayacloud.com/onecloud-ccaas
    email: apiteam@avaya.com
  license:
    name: Avaya Software Development Kit (SDK) Software License Terms
    url: http://support.avaya.com/css/P8/documents/101038288
  version: 1.0.1
servers:
- url: '{protocol}://{server}{basePath}'
  description: Open API
  variables:
    protocol:
      enum:
      - https
      default: https
    server:
      default: HOST-REGION.api.avayacloud.com
    basePath:
      default: /api/admin/group/v1
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Group Management
  description: A Group is a logical collection of the resources like e.g. user. These groups can be assigned to a user to grant access to the resources present in the group.
paths:
  /group-types:
    get:
      tags:
      - Group Management
      summary: Get Group Types
      description: '**This API requires the Account Administrator role.**


        Gets the supported group types.'
      operationId: getGroupTypes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of group types supported
                maxItems: 50
                items:
                  description: supported group types
                  type: string
                  example: User
              example:
              - User
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/groups:
    post:
      tags:
      - Group Management
      summary: Create Group
      description: '**This API requires the Account Administrator role.**


        Creates a group.


        The following fields must be unique otherwise a `HTTP 409 Conflict` will be returned:

        * `name`'
      operationId: createGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
            examples:
              Create-Group:
                $ref: '#/components/examples/Create-Group'
        description: Group with properties which needs to be created
        required: true
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Group:
                  $ref: '#/components/examples/Group'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '409':
          $ref: '#/components/responses/GroupNameConflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Group Management
      summary: List Groups
      description: '**This API requires the Account Administrator role.**


        Lists the groups for an account.'
      operationId: getGroups
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: pageNumber
        in: query
        description: The page number of the records to retrieve. Default value is 1
        required: false
        schema:
          type: integer
          format: int32
          example: 30
          default: 1
          minimum: 1
      - name: pageSize
        in: query
        description: The max number of records to retrieve per page. Default value is 5,max value is 50.
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 5
          minimum: 5
          maximum: 50
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\nThe supported field that you can filter on are:\n  * name\n  * organizationNodeId\n  * membershipType\n\nThe allowed format:\n- Begins with the column name to be filtered, followed by a colon, (This will be used as Contains operator.) then:\n  - Either an exact string to match, or\n  - A string expression including the * wildcard character.\n    - :{PREFIX}* will be used to find out word start with.\n    - :*{POSTFIX} will be used to find out word end with\n    - : will be used to match exact word\n- Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name:Users
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:Users*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*Users
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which sorting needs to be performed.


          The possible fields you ordered on are:

          * name


          Field Names are case-sensitive (should be written as it is in description).


          The default sorting order is ascending.


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending".

          '
        schema:
          type: string
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupPage'
              examples:
                List-Groups:
                  $ref: '#/components/examples/GroupsResult'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/groups/{groupId}:
    get:
      tags:
      - Group Management
      summary: Get Group
      description: '**This API requires the Account Administrator role.**


        Gets a group by ID.'
      operationId: getGroup
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/groupId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Group:
                  $ref: '#/components/examples/Group'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Group Management
      summary: Update Group
      description: '**This API requires the Account Administrator role.**


        Updates a group.


        The following fields must be unique otherwise a `HTTP 409 Conflict` will be returned:

        * `name`'
      operationId: updateGroup
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/groupId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
            examples:
              GroupsUpdateRequest:
                $ref: '#/components/examples/GroupsUpdateRequest'
        description: Group with properties which needs to be updated
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
              examples:
                Group:
                  $ref: '#/components/examples/Group'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '409':
          $ref: '#/components/responses/GroupNameConflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Group Management
      summary: Delete Group
      description: '**This API requires the Account Administrator role.**


        Deletes a group.'
      operationId: deleteGroup
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/groupId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not_Found'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    accountId:
      name: accountId
      description: The unique 6 character internal id that represents the customer account.
      required: true
      in: path
      schema:
        type: string
        minLength: 6
        maxLength: 6
        pattern: ^[a-zA-Z]{6}$
        example: ABCDEF
    groupId:
      name: groupId
      in: path
      description: The unique 36 character internal id that represents the group.
      required: true
      schema:
        type: string
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        minLength: 36
        maxLength: 36
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
  examples:
    ErrorGroupNameExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: A group with this name already exists
    Create-Group:
      description: Create Group Request
      value:
        name: AgentGroup
        description: Group user
        resources:
        - type: User
          resourceIds:
          - 673dab47-5a08-4593-be5a-cdc4d23df814
        organizationNodeId: QTRWAD
    UnauthorizedError:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
        title: Unauthorized
        status: 401
        detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
    Group:
      description: Group Data
      value:
        name: AgentGroup
        groupId: cd79f1f0-9e35-470c-bf70-542a39882b2d
        description: Group user
        resources:
        - type: User
          resourceIds:
          - 673dab47-5a08-4593-be5a-cdc4d23df814
        organizationNodeId: QTRWAD
    ConstraintViolationError:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title: Constraint Violation
        status: 400
        detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
        violations:
        - field: accountId
          message: must match "^[a-zA-Z]{6}$"
          code: 20006
    ServerError:
      description: Internal Server Error
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
        title: Server Error
        status: 500
        detail: An internal server error was encountered.
    GroupsResult:
      description: Groups search response
      value:
        pagination:
          pageNumber: 1
          pageSize: 10
          total: 5
        groups:
        - name: AgentGroup
          groupId: cd79f1f0-9e35-470c-bf70-542a39882b2d
          description: Group user
          resources:
          - type: User
            resourceIds:
            - 673dab47-5a08-4593-be5a-cdc4d23df814
          organizationNodeId: QTRWAD
        links:
        - prev: /api/admin/group/v1/accounts/ASDJGE/groups?pageNumber=1&pageSize=10
          next: /api/admin/group/v1/accounts/ASDJGE/groups?pageNumber=3&pageSize=10
    NotFoundError:
      description: Resource not found
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
        title: Resource Not Found
        status: 404
        detail: Group with id:7b711203-03fe-425c-8503-25826f2b579e not found.
    ForbiddenError:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
        title: Forbidden
        status: 403
        detail: According to the access control policy the current user and/or accountId does not have permission to access this resource.
    GroupsUpdateRequest:
      description: Update Group Request
      value:
        name: AgentGroup
        description: Group user
        resources:
        - type: User
          resourceIds:
          - 673dab47-5a08-4593-be5a-cdc4d23df814
        organizationNodeId: QTRWAD
  responses:
    Not_Found:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/NotFoundError'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ServerError'
    ErrorConstraintViolation:
      description: Constraint Violation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ConstraintViolationError'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ForbiddenError'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/UnauthorizedError'
    GroupNameConflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            name:
              $ref: '#/components/examples/ErrorGroupNameExists'
  schemas:
    Links:
      type: object
      properties:
        prev:
          type: string
          default: ''
          description: URL of the previous page. Blank if currently on the first page.
        next:
          type: string
          default: ''
          description: URL of the next page. Blank if currently on the last page.
    GroupResource:
      type: object
      description: This is container model for group data
      properties:
        type:
          type: string
          description: Type of the group
          example: User
          minLength: 1
          maxLength: 255
          pattern: ^[^<>\^@#]*$
        resourceIds:
          type: array
          maxItems: 500
          items:
            type: string
            minLength: 36
            maxLength: 36
            pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
          example:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: Unique Id's of resources which are member of this group
      required:
      - type
    Group:
      type: object
      description: This model holds the group related data
      properties:
        groupId:
          type: string
          description: Unique group uuid.
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          readOnly: true
          minLength: 36
          maxLength: 36
          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
        name:
          type: string
          description: Name of the group
          example: CreditCardAgentGroup
          minLength: 1
          maxLength: 255
          pattern: ^[^=:*,]*$
        description:
          type: string
          description: Description of the group
          example: Credit Card Agent Group
          minLength: 0
          maxLength: 255
          pattern: ^[^<>\^@#]*$
        organizationNodeId:
          type: string
          example: EXMPLE
          minLength: 0
          maxLength: 6
          pattern: ^[a-zA-Z]{0,6}$
          description: Unique Id for Account or Node where group get created
        resources:
          type: array
          minItems: 1
          maxItems: 50
          description: List of group resource
          items:
            $ref: '#/components/schemas/GroupResource'
    Pagination:
      type: object
      properties:
        pageNumber:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The max number of records that can be retrieved on this page.
        total:
          type: integer
          description: The total number of records.
    Problem:
      type: object
      description: '<b>Problem Detail</b> as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).

            '
          default: about:blank
          example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title:
          type:
          - string
          - 'null'
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).

            '
          example: Service Unavailable
        status:
          type:
          - integer
          - 'null'
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          example: 503
          exclusiveMaximum: 600
        detail:
          type:
          - string
          - 'null'
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type:
          - string
          - 'null'
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

            '
        violations:
          type:
          - array
          - 'null'
          description: 'A list of violations that occurred as a result of invalid data provided as part of a request.

            '
          items:
            type: object
            properties:
              field:
                type: string
                description: 'The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.

                  '
                example: accountId
              message:
                type: string
                description: 'A human readable explanation specific to this occurrence of the violation.

                  '
                example: must match "^[a-zA-Z]{6}$"
              code:
                type: integer
                format: int32
                description: 'The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.

                  '
                example: 20006
          example:
          - field: emailAddress
            message: must not be null
            code: 20002
          - field: accountId
            message: must match "^[a-zA-Z]{6}$"
            code: 20006
    GroupPage:
      type: object
      description: This is container model for group list response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/Group'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Links'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: This API uses Bearer Token Authorization Flow
      bearerFormat: JWT
    AppKey:
      type: apiKey
      in: header
      name: appkey
      description: This API needs an appKey as header
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go