User Role Management APIs System Users Resource

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

Get list of users

get

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

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/users" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \
  -H "Accept: application/xml"

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
  <users>
    <user>pat</user>
    <user>admin</user>
    <user>suzy</user>
    <user>tiffany</user>
    <user>enco*de:te^s_t$</user>
  </users>

Returns: Response object containing an xml list of users in the platform.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Responses

200

Response object containing an xml list of the users in the platform

application/xml

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

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Authorization: Basic username:password
Accept: */*

<?xml version="1.0"?>
<userList>
	<users>text</users>
</userList>