|
SetSecurityUser is used in conjunction with any subsequent API framework actions. This action allows you to select an Agent (from Central/UH in the BU) that has API security permissions within their profile. This is required in order for Studio API/Framework actions to function properly (at least those that call out the SecurityUser parameter within the action. |
Supported Script Types
Properties
| Property | Details |
|---|---|
| Agent |
Allows you to select agents from a drop-down of all agents on the business unit or use a variable value. Accepts copy/paste of an AgentID which will automatically find the associated agent. This field accepts {variables}. |
| TimeZone |
Allows you to specify a timezone from which to return data. Recommended to leave as Default which will use the selected agent’s timezone (not the business unit default). This field accepts {variables}. |
| ScriptVar (out) |
Allows you to re-name the variable output. The default and recommended value is SecurityUser (other API/Framework actions will default the SecurityUser to this variable, recommended to leave as-is). |
Branches
| Branch | Details |
|---|---|
|
Default |
Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined. |
| OnError | Path taken when the action fails to execute properly. |
Tips & Tricks
Create a dedicated API user in the platform with a custom security profile with only API permissions selected. You can set the password to never expire, or adjust the frequency to avoid scripting errors if/when the password expires. The OnError branch can then link to another SetSecurityUser action with a backup user in case the password expires, agent is removed, or permissions revoked.