Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation

System Users Resource


This service allows for listing system users in the BA Platform.

The following resources are applicable:



Returns the list of users in the platform, this list is in an xml format as shown in the example response.

Example Request:

GET pentaho/api/users

Response Body

element: (custom)
media types: application/xml

Response object containing an xml list of users in the platform

Example Response:

<?xml version="1.0" encoding="UTF-8"?>

Status Codes

code description
200 Response object containing an xml list of the users in the platform.
403 Response due to the requesting user not having sufficient privileges.
500 Internal server error occurs when the server cannot retrieve the list of users.

Copyright ©