Commvault Users API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Users API
  description: API for automating Commvault workflows, job scheduling, and policy management. Enables programmatic creation and execution of custom workflows, management of schedule policies, and configuration of automated operations for data protection environments.
  version: v2
  contact:
    name: Commvault Support
    url: https://www.commvault.com/support
  termsOfService: https://www.commvault.com/terms-of-use
servers:
- url: https://{webserver}/webconsole/api
  description: Commvault Web Server
  variables:
    webserver:
      default: webconsole.example.com
      description: Hostname of the Commvault Web Server
security:
- authToken: []
tags:
- name: Users
  description: Manage Commvault users and user groups
paths:
  /User:
    get:
      operationId: listUsers
      summary: Commvault List users
      description: Retrieves a list of all Commvault users, including local and externally authenticated users, their roles, and associated user groups.
      tags:
      - Users
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
  /User/{userId}:
    get:
      operationId: getUser
      summary: Commvault Get user details
      description: Retrieves detailed properties of a specific user, including associated security roles, user groups, and email configuration.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userId'
      responses:
        '200':
          description: User details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
        '404':
          description: User not found
components:
  parameters:
    userId:
      name: userId
      in: path
      required: true
      description: Unique identifier for the user
      schema:
        type: integer
  schemas:
    User:
      type: object
      properties:
        userEntity:
          type: object
          properties:
            userId:
              type: integer
              description: Unique user identifier
            userName:
              type: string
              description: Username
        email:
          type: string
          format: email
          description: User email address
        description:
          type: string
          description: User description
        enabled:
          type: boolean
          description: Whether the user account is enabled
        associatedUserGroups:
          type: array
          items:
            type: object
            properties:
              userGroupName:
                type: string
                description: Name of the user group
  securitySchemes:
    authToken:
      type: apiKey
      in: header
      name: Authtoken
      description: QSDK authentication token obtained from the Login endpoint.
externalDocs:
  description: Commvault Automation API Documentation
  url: https://documentation.commvault.com/v11/essential/rest_api_automation.html