Documentation Center

UserRole 2.5 Update

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

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.
psUserRoleIdStringInThe element name of the user role (e.g. VUSERROLEADMINISTRATOR)
psXMLMetaDataStringInMetadata XML structure with the metadata that will be set on the current object

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