Toggle menu

User - Update Groups

Takes the login provider user name returned from the user name function, looks up the account user the login is linked to, and updates the groups the account user is in.

Properties

LabelDescriptionType Name
Failure MessageMessage to be displayed when an error occurs when trying to update the user's groupsFAILUREMESSAGE
User Groups FunctionThe JavaScript function that is executed server-side to set the user's new groups. It must return a comma-delimited list of group IDs

function(helper, currentGroupIDs) {
...
}
GROUPSFUNC
Success MessageThe message to display when the user's groups have been successfully updated. Leave blank for no messageSUCCESSMESSAGE
Account User ID FunctionThe JavaScript function that is executed server-side to get the ID of the user to update groups for, eg

function (helper) {
  return helper.getSiteVariable('SITEUSERID');
}
USERIDFUNC
Stop Processing on ErrorIf true, and an error is encountered, further action fields on the form won't be processed. See The Form Lifecycle: Control and Action Processing for more informationSTOPPROCESSINGONERROR
DocumentationAdd documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an exampleDOCUMENTATION
Last modified on March 02, 2022

Share this page

Facebook icon Twitter icon email icon

Print

print icon