openapi: 3.0.3
info:
  title: Windstream Enterprise Contact Center Services agents users API
  description: The Windstream Enterprise Contact Center Services (CCS) API provides programmatic access to contact center operations, enabling developers to route calls, web chats, and text messages, manage agent states, configure tenants, and monitor queue activity. The REST API is complemented by a WebSocket interface for real-time event streaming.
  version: 2.0.0
  contact:
    name: Windstream Enterprise Developer Support
    url: https://api.solutions.uniti.com/
  termsOfService: https://www.windstreamenterprise.com/legal/
servers:
- url: https://{ccs_domain}/6/v2/api
  description: CCS REST API
  variables:
    ccs_domain:
      default: ccs.windstreamenterprise.com
      description: CCS domain hostname
tags:
- name: users
  description: User account management
paths:
  /users:
    get:
      operationId: listUsers
      summary: List Users
      description: Returns a list of all users configured in the system.
      tags:
      - users
      responses:
        '200':
          description: List of users
          content:
            application/hal+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
    post:
      operationId: createUser
      summary: Create User
      description: Creates a new user account.
      tags:
      - users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
  /users/{userId}:
    get:
      operationId: getUser
      summary: Get User
      description: Retrieves details of a specific user.
      tags:
      - users
      parameters:
      - name: userId
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      responses:
        '200':
          description: User details
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/User'
    put:
      operationId: updateUser
      summary: Update User
      description: Updates an existing user's configuration.
      tags:
      - users
      parameters:
      - name: userId
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
      responses:
        '200':
          description: User updated
    delete:
      operationId: deleteUser
      summary: Delete User
      description: Removes a user account.
      tags:
      - users
      parameters:
      - name: userId
        in: path
        required: true
        description: User identifier
        schema:
          type: string
      responses:
        '200':
          description: User deleted
components:
  schemas:
    UserCreate:
      type: object
      description: Request body for creating or updating a user
      required:
      - username
      - email
      properties:
        username:
          type: string
          description: Login username
        email:
          type: string
          description: Email address
        extension:
          type: string
          description: Extension to assign
        role:
          type: string
          description: User role
          enum:
          - admin
          - user
          - read_only
    User:
      type: object
      description: A user account
      properties:
        id:
          type: string
          description: User identifier
        username:
          type: string
          description: Login username
        email:
          type: string
          description: Email address
        extension:
          type: string
          description: Assigned extension number
        role:
          type: string
          description: User role
          enum:
          - admin
          - user
          - read_only
        tenant:
          type: string
          description: Tenant ID
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication for CCS API