Get users for roles

Use this step to fetch all users by the application role.

Last published at: July 13th, 2023

getUsersForRole Step


Get users assigned to the application role and store them on a variable.


  • roleID – selected role
  • variableToStoreValue – Variable to store the value 



  • True – step executed successfully
  • False – step failed to execute 




Let’s build and execute the “GetUsersForRoleDef” example.          

  • Create a new definition called “GetUsersForRoleDef” 
  • Select the definition and click the “design” button
  • Drag a “getUsersForRole” from the toolbox
  • Connect the dots between the start and “getUsersForRole” step 
  • Define a variable/global to store the user's list GUID values after execution
  • Click on the "getUsersForRole" step to configure its "Settings" properties. Provide a name to the step. Click on the button to select the application roles. Provide a variable/global to store the users list GUID values after execution.
  • Click on the button to select the application roles.
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. 
  • Render the process instance. Click on the process step. The step should get users GUID values for the selected roles and store in the variable/global as configured.