Expand Minimize

SPC059005: Consider verifying that the user has sufficient permissions when calling Web.Update().

Before executing an update on a Web object, it is a good idea to make sure the user has permissions to perform that action.

CheckId SPC059005
TypeName CheckHasWebPermissionsBeforeUpdate
Severity Warning
Type Assembly

Bad Practice

using (ClientContext context = new ClientContext("http://yoursite"))
{
    Web web = context.Web;
    web.Title = "My Web Title";
    web.Description = "My Web Description";
    web.Update();
    context.ExecuteQuery();
}

Good Practice
using (ClientContext context = new ClientContext("http://yoursite"))
{
    Web web = context.Web;
    var permissions = new BasePermissions();
    permissions.Set(PermissionKind.ManageWeb);

    var permissionResults = web.DoesUserHavePermissions(permissions);
    context.ExecuteQuery();

    if (permissionResults.Value)
    {
        web.Title = "My New Web Title";
        web.Description = "My New Web Description";
        web.Update();
        context.ExecuteQuery();
    }
}

To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.

// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("SPCAF.Rules.ManagedCSOM.CSOMBestPracticesGroup", "SPC059005:CheckHasWebPermissionsBeforeUpdate", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.