RoleService

The RoleService contains functions related to roles, which are used to control access to applications, as well as access to specific functionality within an application.

The table below lists the functions available from the RoleService.

All RoleService functions require the viewRoles system action.

Function Description Returns
getRoleModel Retrieves the role model for the specified role. RoleModel
getRoleSettings Retrieves the settings for a role for the specified application. You can also optionally request the role settings for a specific component in the application. RoleSettings
listRolesExt Lists the available roles. You can optionally provide a list of targets (groups or positions). If specified, roles mapped to the targets are returned. If omitted, all roles are returned. The list should be passed in the body as a JSON array. List<Role>
Note: Role administration functions (creating, mapping, and so on) are not available from the objectAPI. For information about performing those types of functions, see the TIBCO ActiveMatrix BPM Client Application Management Guide.