Class SystemUsersResource
- java.lang.Object
-
- org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
-
- org.pentaho.platform.web.http.api.resources.SystemUsersResource
-
public class SystemUsersResource extends AbstractJaxRSResource
This service allows for listing system users in the BA Platform.
-
-
Field Summary
-
Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
acceptableMediaTypes, httpServletRequest, httpServletResponse, TEXT_HTML
-
-
Constructor Summary
Constructors Constructor Description SystemUsersResource()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected javax.ws.rs.core.Response
buildOkResponse(Object entity, String type)
protected SystemService
getSystemService()
javax.ws.rs.core.Response
getUsers()
Returns the list of users in the platform, this list is in an xml format as shown in the example response.-
Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource
setHttpHeaders
-
-
-
-
Method Detail
-
getUsers
public javax.ws.rs.core.Response getUsers() throws Exception
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
- Returns:
- Response object containing an xml list of users in the platform
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>
- Throws:
Exception
-
getSystemService
protected SystemService getSystemService()
-
-