Set-ItemAcl
Sets new security information on an item overwriting the previous settings.
Syntax
1
Set-ItemAcl -AccessRules <AccessRuleCollection> [-Path] <String> [-PassThru]
2
Set-ItemAcl -AccessRules <AccessRuleCollection> -Id <String> [-Database <String>] [-PassThru]
3
Set-ItemAcl -AccessRules <AccessRuleCollection> [-Item] <Item> [-PassThru]
Copied!
Detailed Description
Sets new security information on an item. The new rules will overwrite the existing security descriptors on the item.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Parameters
-AccessRules <AccessRuleCollection>
A single or multiple access rules created e.g. through the New-ItemAcl or obtained from other item using the Get-ItemAcl cmdlet. This information will overwrite the existing security descriptors on the item.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-PassThru <SwitchParameter>
Passes the processed object back into the pipeline.
Aliases
Text
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Item <Item>
The item to be processed.
Aliases
Text
Required?
true
Position?
1
Default Value
​
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false
-Path <String>
Path to the item to be processed.
Aliases
Text
Required?
true
Position?
1
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Id <String>
Id of the item to be processed. Requires the Database parameter to be specified.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Database <String>
Database containing the item to be fetched with Id parameter.
Aliases
Text
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- can be piped from another cmdlet* Sitecore.Data.Items.Item
Outputs
The output type is the type of the objects that the cmdlet emits.
- Only if -PassThru is used* Sitecore.Data.Items.Item
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE 1
Take the security information from the Home item and apply it to the Settings item
1
$acl = Get-ItemAcl -Path master:\content\home
2
Set-ItemAcl -Path master:\content\Settings -AccessRules $acl -PassThru
Copied!
EXAMPLE 2
Allows the "sitecore\adam" user to delete the Home item and all of its children. Denies the "sitecore\mikey" user reading the descendants of the Home item. ;P The security info is created prior to setting it to the item. The item is delivered to the Set-ItemAcl from the pipeline and returned to the pipeline after processing due to the -PassThru parameter. Any previuous security information on the item is removed.
1
$acl1 = New-ItemAcl -AccessRight item:delete -PropagationType Any -SecurityPermission AllowAccess -Identity "sitecore\adam"
2
$acl2 = New-ItemAcl -AccessRight item:read -PropagationType Descendants -SecurityPermission DenyAccess -Identity "sitecore\mikey"
3
Get-Item -Path master:\content\home | Set-ItemAcl -AccessRules $acl1, $acl2 -PassThru
4
​
5
Name Children Languages Id TemplateName
6
---- -------- --------- -- ------------
7
Home False {en, ja-JP, de-DE, da} {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
Copied!
EXAMPLE 3
The following applies a new set of AccessRule to an item using
Set-ItemAcl and New-ItemAcl when the PropogationType and SecurityPermission are the same.1
$role = "sitecore\yourrole"
2
$rights = @("item:create", "item:write", "item:rename", "item:delete")
3
​
4
Get-Item -Path master:\content\youritem | Set-ItemAcl -AccessRules ($rights | ForEach-Object { New-ItemAcl -AccessRight $_ -PropagationType Any -SecurityPermission AllowAccess -Identity $role })
Copied!
Related Topics
Last modified 10d ago