Documentation Center

UserGroup 2.5 Update

This topic describes the function which can be used to update an user group

Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
psUserGroupIdStringInThe element name of the user group (e.g. VUSERGROUPDEFAULTDEPARTMENT)
psXMLMetaDataStringInMetadata XML structure with the metadata that will be set on the current object

Requirements are:
  • Only an 'Administrator' user can update an user group.
Note that:
  • User groups can be used to define access management.
  • The level attribute on the ishfield element must be 'none'.
  • In order to rename the user group you can add the field FISHUSERGROUPNAME with the new user group name to psXMLMetaData.
  • To deactivate the user group, add the following statement to psXMLMetaData
    <ishfield name='FISHOBJECTACTIVE' level='none' ishvaluetype='element'>FALSE</ishfield>