XML Parameters for Roles

description

The description of the role.

roleName

The name of the role.

categoriesPermissionOperationType

The operation to perform on the categories and permissions in the categoryName and permissionName parameters.

Valid values are:

• ADD, to add new categories and permissions to a role.

• OVERWRITE, to overwrite categories and permissions.

• DELETE, to delete categories and permissions.

categoryName

The name of the category operated on by the categoriesPermissionOperationType parameter. A category includes multiple permissions.

Valid values are:

permissionName

The name of the permission operated on by the categoriesPermissionOperationType parameter.

To work with multiple permissions, add the following elements in the XML file for each permission:

<categoriesPermissionList>
  <permissionName></permissionName>
</categoriesPermissionList>

For a list of valid values, see User Security Permissions and Permitted Actions.

exclude

The option to exclude a permission from a category.

For example, a role includes all of the permissions in the User Management category except for the Change security setting permission:

<categoryPermission>
<categoriesPermissionOperationType>ADD</categoriesPermissionOperationType>
  <categoriesPermissionList>
    <categoryName>User Management</categoryName>
  </categoriesPermissionList>
  <categoriesPermissionList>
    <permissionName>Change Security Settings</permissionName>
    <flags>
      <exclude>true</exclude>
    </flags>
  </categoriesPermissionList>
</categoryPermission>