Role Element (DeploymentManifest)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Represents an instance of a Windows SharePoint Services 3.0 deployment role (DeploymentRole) object.

Definition

DECLARATION
<xs:element name="Role" type="DeploymentRole" minOccurs="0" maxOccurs="unbounded" />

USAGE
<Roles>
        <Role
                RoleId="xs:string"
                Title="xs:string"
                Description="xs:string"
                PermMask="xs:string"
                Hidden="xs:boolean"
                RoleOrder="xs:string"
                Type="xs:string"
        />
</Roles>

Type

DeploymentRole (based on SPRole)

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Type	Description
RoleId	xs:string	Required. Integer that specifies the member ID.
Title	xs:string	Required. Specifies the name for the role.
Description	xs:string	Optional. Provides a description of the role.
PermMask	xs:string	Required. Specifies a permission mask for the role.
Hidden	xs:boolean	Required. Specifies whether the role is hidden; true if the role is hidden, otherwise, false.
RoleOrder	xs:string	Optional. Specifies the order in which permission levels are displayed on the Permission Levels page of a site collection.
Type	xs:string	Optional. Specifies the role type, as listed in the Microsoft.SharePoint.SPRoleType enumeration.

Child elements

None

Parent elements

Roles Element (DeploymentManifest)

Remarks

The value of the RoleID property corresponds to the unique member ID for the role, which is specified in the SPMember.ID property of the SPMember class.

Share via