UCX Suite Users' List

GET /Users

• HTTP Method: GET

• URL: /Users

Request

• Authentication: Required (Basic Auth via UserSecurity)

• Query Parameters:

  • pbxUsername (string, optional): The username of the user in the PBX.
    Example: "pbx.john_doe"

  • adUsername (string, optional): The username of the user in Active Directory.
    Example: "ad.john_doe"

  • tenantId (string, optional): The tenant id of the user (available to users with complete management privileges).
    Example: "ACME"

Response

• 200 OK:
  Returns a JSON array of user objects. Each user object contains:

  • username (string): Username
    Example: "john_doe"

  • firstName (string): User's first name
    Example: "John"

  • lastName (string): User's last name
    Example: "Doe"

  • telephoneAddress (string): User's primary extension number
    Example: "123456"

• Error Responses:

  • 401 Unauthorized: No authentication provided or wrong credentials.

  • 403 Forbidden: Authenticated user is not allowed to perform this operation.

  • 500 Internal Server Error: An error occurred while processing the request.