User Role List Resource
Overview
The UserRoleListResource service lists roles, permissions, and users. Provides a list of users per role and roles per user.
The following resources are applicable:
- /userrolelist/allRoles
- /userrolelist/extraRoles
- /userrolelist/getRolesForUser
- /userrolelist/getUsersInRole
- /userrolelist/permission-roles
- /userrolelist/permission-users
- /userrolelist/roles
- /userrolelist/systemRoles
- /userrolelist/users
/userrolelist/allRoles
GET
Get a list of the all roles in the platform including Anonymous and Administrator.
Example Request:
GET pentaho/api/userrolelist/allRoles
Response Body
| element: | roleList |
| media types: | application/xml application/json |
A list of Role objects that contains all the roles in the platform.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <roleList> <roles>Anonymous</roles> <roles>Business Analyst</roles> <roles>Authenticated</roles> <roles>Report Author</roles> <roles>Power User</roles> <roles>Authenticated</roles> <roles>Anonymous</roles> </roleList>
/userrolelist/extraRoles
GET
Returns roles identified as "extra roles" from the repository.
Example Request:
GET pentaho/api/userrolelist/extraRoles
Response Body
| element: | roleList |
| media types: | application/xml application/json |
Roles identified as "extra roles" are returned as a list from the repository as shown in the example.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <roleList> <roles>Authenticated</roles> <roles>Anonymous</roles> </roleList>
/userrolelist/getRolesForUser
GET
Gets the roles for the given user.
Example Request:
GET pentaho/api/userrolelist/getRolesForUser?user=admin
Parameters
| name | description | type |
|---|---|---|
| user | The username to get the roles for | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
A list of Role objects containing the roles for the given user.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <roles> <role>Administrator</role> <role>Authenticated</role> </roles>
/userrolelist/getUsersInRole
GET
Gets the list of users that have the role specified by the role parameter. The list of valid roles can be obtained by calling the /roles endpoint.
Example Request:
GET pentaho/api/userrolelist/getUsersInRole?role=Authenticated
Parameters
| name | description | type |
|---|---|---|
| role | The role to get the users for | query |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
A list of User objects that have the roles specified in the role parameter.
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>
/userrolelist/permission-roles
GET
Return a list of the permission roles in the platform.
Example Request:
GET pentaho/api/userrolelist/permission-roles
Response Body
| element: | roleList |
| media types: | application/xml application/json |
A list of permission roles in the platform.
Example Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <roleList> <roles>Anonymous</roles> <roles>Business Analyst</roles> <roles>Authenticated</roles> <roles>Report Author</roles> <roles>Power User</roles> </roleList>
/userrolelist/permission-users
GET
Returns the list of permission users in the platform.
Example Request:
GET pentaho/api/userrolelist/permission-users
Response Body
| element: | userList |
| media types: | application/xml application/json |
A list of User objects for users with permissions in the platform.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <userList> <users>pat</users> <users>admin</users> <users>suzy</users> <users>tiffany</users> <users>enco*de:te^s_t$</users> </userList>
/userrolelist/roles
GET
Get a list of the standard roles in the platform.
Example Request:
GET pentaho/api/userrolelist/roles
Response Body
| element: | roleList |
| media types: | application/xml application/json |
A list of Role objects that contains the standard roles in the platform.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <roleList> <roles>Anonymous</roles> <roles>Business Analyst</roles> <roles>Authenticated</roles> <roles>Report Author</roles> <roles>Power User</roles> </roleList>
/userrolelist/systemRoles
GET
Returns Roles identified as "system roles" from the repository.
Example Request:
GET pentaho/api/userrolelist/systemRoles
Response Body
| element: | roleList |
| media types: | application/xml application/json |
A list of system roles.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <roleList> <roles>Authenticated</roles> <roles>Administrator</roles> <roles>Anonymous</roles> </roleList>
/userrolelist/users
GET
Returns the list of users in the platform.
Example Request: GET pentaho/api/userrolelist/users
Response Body
| element: | userList |
| media types: | application/xml application/json |
A list of User objects for users in the platform.
Example Response:
<?xml version="1.0" encoding="UTF-8"?> <userList> <users>pat</users> <users>admin</users> <users>suzy</users> <users>tiffany</users> <users>enco*de:te^s_t$</users> </userList>