> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/rest-api/user-role-management-apis-system-users-resource.md).

# User Role Management APIs   System Users Resource

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

## Get list of users

> 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:\*\*\
> \`\`\`bash\
> curl -X GET \\\
> &#x20; "<http://localhost:8080/pentaho/api/users>" \\\
> &#x20; -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\
> &#x20; -H "Accept: application/xml"\
> \`\`\`\
> \
> \*\*Example Response:\*\*\
> \`\`\`xml\
> \<?xml version="1.0" encoding="UTF-8"?>\
> &#x20; \<users>\
> &#x20;   \<user>pat\</user>\
> &#x20;   \<user>admin\</user>\
> &#x20;   \<user>suzy\</user>\
> &#x20;   \<user>tiffany\</user>\
> &#x20;   \<user>enco\*de:te^s\_t$\</user>\
> &#x20; \</users>\
> \`\`\`\
> \
> \*\*Returns:\*\*\
> Response object containing an xml list of users in the platform.<br>

````json
{"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"User Role Management APIs - System Users Resource","description":"This service allows for listing system users in the BA Platform."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}},"schemas":{"UserList":{"type":"object","description":"List of users in the platform","properties":{"users":{"type":"array","description":"Array of usernames","items":{"type":"string"}}},"xml":{"name":"userList"}}}},"paths":{"/users":{"get":{"tags":["User Role Management APIs - System Users Resource"],"summary":"Get list of users","produces":["application/xml"],"description":"Returns the list of users in the platform, this list is in an xml format as shown in the example response.\n\n**Example Request:**\n```\nGET pentaho/api/users\n```\n\n**cURL Example:**\n```bash\ncurl -X GET \\\n  \"http://localhost:8080/pentaho/api/users\" \\\n  -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n  -H \"Accept: application/xml\"\n```\n\n**Example Response:**\n```xml\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n  <users>\n    <user>pat</user>\n    <user>admin</user>\n    <user>suzy</user>\n    <user>tiffany</user>\n    <user>enco*de:te^s_t$</user>\n  </users>\n```\n\n**Returns:**\nResponse object containing an xml list of users in the platform.\n","responses":{"200":{"description":"Response object containing an xml list of the users in the platform","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UserList"}}}},"403":{"description":"Response due to the requesting user not having sufficient privileges"},"500":{"description":"Internal server error occurs when the server cannot retrieve the list of users"}}}}}}
````


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pentaho.com/rest-api/user-role-management-apis-system-users-resource.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.