Documentation Center

UserGroup 2.5 Create

This topic describes the function which allows you to create 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.
psUserGroupNameStringInThe name of the user group (e.g. Default Department)
psXMLMetaDataStringInMetadata XML structure with the metadata that will be set on the current object
psOutUserGroupIdStringOutThe element name of the new user group

Requirements are:
  • Only an 'Administrator' user can create an user group.
Note that:
  • User groups can be used to define access management.
  • The level attribute on the ishfield element must be 'none'.
  • The internal element name is generated using the prefix VUSERGROUP and the given psUserGroupName value (see Naming conventions for readable Element Names).
  • The name of the user group must be unique