Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

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

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>

Status Codes

code description
200 Successfully retrieved the list of Role objects.

/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>

Status Codes

code description
200 Successfully returns extra role list.

/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>

Status Codes

code description
200 Successfully retrieved the list of Role objects.
500 Invalid user parameter.

/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>

Status Codes

code description
200 Successfully retrieved the list of User objects.
500 Missing the role parameter.

/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>

Status Codes

code description
200 Successfully retrieved the list of permission roles.

/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>

Status Codes

code description
200 Successfully retrieved the list of User objects.
500 Unable to retrieve User objects.

/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>

Status Codes

code description
200 Successfully retrieved the list of Role objects.

/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>

Status Codes

code description
200 Successfully returns system role list.

/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>

Status Codes

code description
200 Successfully retrieved the list of User objects.
500 Unable to retrieve User objects.

Copyright © Pentaho.com