3.1.5.115 proc_SecResetWebToDefaultRoleDefinition

The proc_SecResetWebToDefaultRoleDefinition stored procedure is invoked to replace existing roles, role assignments, and permissions for a specified site and its subsites with a default set of role definitions, as specified by input parameters. If the specified site inherits its security permissions, then a new security scope will be made to hold the new security settings. proc_SecResetWebToDefaultRoleDefinition will fail if the specified site does not exist or if the specified site has a unique role definition.

 PROCEDURE proc_SecResetWebToDefaultRoleDefinition(
       @WebId                         uniqueidentifier,
       @AuthorID                      int,
       @AdminsName                    nvarchar(255),
       @AdminsDescription             nvarchar(512),
       @AdminsPermMask                bigint,
       @AuthorsName                   nvarchar(255),
       @AuthorsDescription            nvarchar(512),
       @AuthorsPermMask               bigint,
       @ContributorsName              nvarchar(255),
       @ContributorsDescription       nvarchar(512),
       @ContributorsPermMask          bigint,
       @BrowsersName                  nvarchar(255),
       @BrowsersDescription           nvarchar(512),
       @BrowsersPermMask              bigint,
       @GuestsName                    nvarchar(255),
       @GuestsDescription             nvarchar(512),
       @GuestsPermMask                bigint,
       @AnonymousPermMask             bigint,
       @ScopeId                       uniqueidentifier OUTPUT,
       @RequestGuid                   uniqueidentifier   = NULL OUTPUT
 );

@WebId: The site identifier (section 2.2.1.11) of the site.

@AuthorID: The user identifier (section 2.2.1.13) of the principal to be assigned to the Administrator Role. This MUST be the user identifier of an existing principal in the site collection.

@AdminsName: The display name for the Administrator Role. This value MUST NOT be NULL.

@AdminsDescription: The description for the Administrator Role.

@AdminsPermMask: The WSS Rights Mask (section 2.2.2.14) for the Administrator Role. This value MUST NOT be NULL.

@AuthorsName: The display name for the Web Designer Role. This value MUST NOT be NULL.

@AuthorsDescription: The description for the Web Designer Role.

@AuthorsPermMask: The WSS Rights Mask for the Web Designer Role. This value MUST NOT be NULL.

@ContributorsName: The display name for the Contributor Role. This value MUST NOT be NULL.

@ContributorsDescription: The description for the Contributor Role.

@ContributorsPermMask: The WSS Rights Mask for the Contributor Role. This value MUST NOT be NULL.

@BrowsersName: The display name for the Reader Role. This value MUST NOT be NULL.

@BrowsersDescription: The description for the Reader Role.

@BrowsersPermMask: The WSS Rights Mask for the Reader Role. This value MUST NOT be NULL.

@GuestsName: The display name for the Guest Role. This value MUST NOT be NULL.

@GuestsDescription: The description for the Guest Role.

@GuestsPermMask: The WSS Rights Mask for the Guest Role. This value MUST NOT be NULL.

@AnonymousPermMask: A WSS Rights Mask that indicates the rights granted to a user that is anonymous, or has no specific rights.

@ScopeId: The scope identifier (section 2.2.1.8) of the security scope of the updated permissions, returned as an output parameter.

@RequestGuid: The optional request identifier for the current request.

Return Values: The proc_SecResetWebToDefaultRoleDefinition stored procedure returns an integer return code which MUST be in the following table.

Value

Description

0

Successful execution.

3

Site does not exist or site has a unique role definition associated with it.

If execution is not successful, then the proc_SecResetWebToDefaultRoleDefinition stored procedure MUST return no result sets. Otherwise, proc_SecResetWebToDefaultRoleDefinition MUST return the Site Audit Mask Result Set six times.