This help page is for CXone Studio. This information is also available for Desktop Studio.

SetSecurityUser provides secure access to the CXone platform for API actions used in your scripts. This is required for those actions to function properly.


  • To use this action, you need to create a security user in CXone. The security user is an employee profile that has the appropriate permissions. Assign it permissions that allow it to perform the tasks required by the API actions you use it with. There isn't a set list of permissions, because every action is different.
  • In CXone Studio this action is located on the API Actions palette.

Supported Script Types

A square with a line branching from it that goes to three other squares.


Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.



Add Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.


Select the CXone employee profile you created to be a security user. You can enter agent ID of that employee profile instead of searching for the user. This field accepts variables enclosed in curly braces ( { } ).


Allows you to specify a timezone from which to return data. It's recommended to leave as Default, so that it uses the selected agent’s timezone (not the business unitClosed High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment default). This field accepts variables enclosed in curly braces ( { } ).

Script Variable

The variable that holds the output of this action. It's recommended that you leave this set to the default SecurityUser.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.




Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.


Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.