Permissions.AddPermission method

Modifies site-level permissions for the site group that exists on the site, or adds or modifies permissions to the specified list for the user, site group, or cross-site group that exists on the site.

Namespace:  WebSvcPermissions
Assembly:  STSSOAP (in STSSOAP.dll)

Syntax

'Declaration
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/directory/AddPermission", RequestNamespace := "https://schemas.microsoft.com/sharepoint/soap/directory/",  _
    ResponseNamespace := "https://schemas.microsoft.com/sharepoint/soap/directory/",  _
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)> _
Public Sub AddPermission ( _
    objectName As String, _
    objectType As String, _
    permissionIdentifier As String, _
    permissionType As String, _
    permissionMask As Integer _
)
'Usage
Dim instance As Permissions
Dim objectName As String
Dim objectType As String
Dim permissionIdentifier As String
Dim permissionType As String
Dim permissionMask As Integer

instance.AddPermission(objectName, objectType, _
    permissionIdentifier, permissionType, _
    permissionMask)
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sharepoint/soap/directory/AddPermission", RequestNamespace = "https://schemas.microsoft.com/sharepoint/soap/directory/", 
    ResponseNamespace = "https://schemas.microsoft.com/sharepoint/soap/directory/", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
public void AddPermission(
    string objectName,
    string objectType,
    string permissionIdentifier,
    string permissionType,
    int permissionMask
)

Parameters

  • objectName
    Type: System.String

    A string that contains the name of the list or site.

  • objectType
    Type: System.String

    A string that specifies either List or Web.

  • permissionIdentifier
    Type: System.String

    A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.

  • permissionType
    Type: System.String

    A string that specifies user, group (cross-site group), or role (site group). The user or cross-site group has to be valid, and the site group has to already exist on the site.

  • permissionMask
    Type: System.Int32

    A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ("|") in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.

Remarks

To access the Permissions service and its methods, set a Web reference to https://Server_Name/[sites/][Site_Name/]_vti_bin/Permissions.asmx.

Examples

The following code example adds or modifies permissions to a list for an existing cross-site group.

Dim permService As New Web_Reference_Folder_Name.Permissions()
permService.Credentials = System.Net.CredentialCache.DefaultCredentials

permService.AddPermission("List_Name", "List", "Group_Name", "group", &H2 Or &H400)
Web_Reference_Folder_Name.Permissions permService = new Web_Reference_Folder_Name.Permissions();
permService.Credentials= System.Net.CredentialCache.DefaultCredentials;

permService.AddPermission("List_Name", "List", "Group_Name", "group", 0x00000002 | 0x00000400);

See also

Reference

Permissions class

Permissions members

WebSvcPermissions namespace