RoleX Element (DeploymentManifest)

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

Represents a security role in cases where incremental changes to the base object are being deployed.

Definition

DECLARATION
<xs:element name="RoleX" type="DeploymentRoleX" />

USAGE
<SPObject>
        <RoleX
                Operation="SecurityModificationType"
                OperationCode="xs:string"
                WebId="xs:string"
                WebUrl="xs:string"
                RoleId="xs:string"
                Title="xs:string"
                Description="xs:string"
                PermMask="xs:string"
                Hidden="xs:boolean"
                RoleOrder="xs:string"
                Type="xs:string"
                UserId="xs:string"
                UserLogin="xs:string"
        />
</SPObject>

Type

DeploymentRoleX (based on SPRole)

Elements and attributes

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

Attributes

Attribute	Type	Description
Operation	SecurityModificationType Simple Type (DeploymentManifest)	Required. Enumeration type that specifies which security role modifications are allowed.
OperationCode	xs:string	Required.
WebId	xs:string	Required. Identifier of the website to which changes are deployed.
WebUrl	xs:string	Required. URL of the website to which changes are deployed.
RoleId	xs:string	Optional. Identifier of the security role for objects that are deployed.
Title	xs:string	Optional. Display name of the role.
Description	xs:string	Optional. Description of the role.
PermMask	xs:string	Optional. Permission mask for the role.
Hidden	xs:bool	Optional. Specifies whether the role is hidden; true if hidden, otherwise, false.
RoleOrder	xs:string	Optional. Position of the role in
Type	xs:string	Optional. Type for the role as listed in the Microsoft.SharePoint.SPRoleType enumeration.
UserId	xs:string	Optional. Identifier of users that belong to the role.
UserLogin	xs:string	Optional. Logon credential for user.

Child elements

None

Parent elements

SPObject Element (DeploymentManifest)