Documentation Center

UserRole 2.5 Create

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

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