3.1.4.2.2.1 AddPermissionCollection

  • Article

The input data of an AddPermissionCollection operation. The definition of the AddPermissionCollection element is as follows:

 <s:element name="AddPermissionCollection">
  <s:complexType>
   <s:sequence>
    <s:element name="objectName" type="s:string" minOccurs="1"/>
    <s:element name="objectType" type="s:string" minOccurs="1"/>
    <s:element name="permissionsInfoXml" minOccurs="1">
     <s:complexType>
      <s:sequence>
       <s:element name="Permissions">
        <s:complexType>
         <s:sequence>
          <s:element name="Users" minOccurs="0" maxOccurs="1">
           <s:complexType>
            <s:sequence>
             <s:element minOccurs="0" maxOccurs="100" name="User">
              <s:complexType>
               <s:attribute name="LoginName" type="s:string" use="required" />
               <s:attribute name="Email" type="s:string" use="optional" />
               <s:attribute name="Name" type="s:string" use="optional" />
               <s:attribute name="Notes" type="s:string" use="optional" />
               <s:attribute name="PermissionMask" type="s:int" use="required" />
              </s:complexType>
             </s:element>
            </s:sequence>
           </s:complexType>
          </s:element>
          <s:element name="Groups" minOccurs="0" maxOccurs="1">
           <s:complexType>
            <s:sequence>
             <s:element minOccurs="0" maxOccurs="100" name="Group">
              <s:complexType>
               <s:attribute name="GroupName" type="s:string" use="required" />
               <s:attribute name="PermissionMask" type="s:int" use="required" />
              </s:complexType>
             </s:element>
            </s:sequence>
           </s:complexType>
          </s:element>
          <s:element name="Roles" minOccurs="0" maxOccurs="1">
           <s:complexType>
            <s:sequence>
             <s:element minOccurs="0" maxOccurs="100" name="Role">
              <s:complexType>
               <s:attribute name="RoleName" type="s:string" use="required" />
               <s:attribute name="PermissionMask" type="s:int" use="required" />
              </s:complexType>
             </s:element>
            </s:sequence>
           </s:complexType>
          </s:element>
         </s:sequence>
        </s:complexType>
       </s:element>
      </s:sequence>
     </s:complexType>
    </s:element>
   </s:sequence>
  </s:complexType>
 </s:element>

objectName: A string that contains the name of a list or a site. The list or site specified in this parameter MUST exist on the protocol server.

objectType: A string that specifies whether permissions are to be added to a list or a site. The value MUST be "list" for a list or "web" for a site.

permissionsInfoXml: An XML fragment that contains the permissions to add. The XML fragment MUST adhere to the schema specified previously in this section.

Permissions: A complex type that represents the permissions to add.

Users: A complex type that represents a collection of existing users with specified permissions.

User: A complex type that represents an existing user with specified permissions.

User.LoginName: A string that specifies the user identifier (login).

User.Email: A string that specifies the user email.

User.Name: A string that specifies the user name.

User.Notes: A string that specifies the user notes.

User.PermissionMask: A Rights Mask that represents the lower 32 bits of the WSS Rights Mask that is specified in [MS-WSSFO3] section 2.2.2.15.

Groups: A complex type that represents a collection of existing cross-site groups with specified permissions.

Group: A complex type that represents an existing cross-site group with specified permissions.

Group.GroupName: A string that specifies the cross-site group name.

Group.PermissionMask: A Rights Mask that is represents the lower 32 bits of the WSS Rights Mask that is specified in [MS-WSSFO3] section 2.2.2.15.

Roles: A complex type that represents a collection of existing roles with specified permissions.

Role: A complex type that represents an existing role definition for a user, group, or Web site.

Role.RoleName: A string that specifies the role name.

Role.PermissionMask: A Rights Mask that represents the lower 32 bits of the WSS Rights Mask that is specified in [MS-WSSFO3] section 2.2.2.15.