Package org.pentaho.platform.web.http.api.resources

Class SystemUsersResource

  • public class SystemUsersResource
extends AbstractJaxRSResource
    This service allows for listing system users in the BA Platform.

    • Constructor Detail

      • SystemUsersResource

        public SystemUsersResource()

    • 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

      • buildOkResponse

        protected javax.ws.rs.core.Response buildOkResponse​(Object entity,
                                                    String type)