Permalink
Browse files

Documentation update WIP

  • Loading branch information...
AdamNaj committed Jun 14, 2015
1 parent 6bcb96b commit ab60a630ec73a593c7af72ac870d7702ad60d9ac

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,121 @@
<#
.SYNOPSIS
Adds new access rule to an item allowing for the item to have the access granted or denied for a provided role or user.
.DESCRIPTION
Adds new access rule to an item allowing for the item to have the access granted or denied for a provided role or user.
.PARAMETER AccessRules
TODO: Provide description for this parameter
.PARAMETER PropagationType
The PropagationType enumeration determines which items will be granted the access right.
- Any - the item and all items inheriting
- Descendants - applies rights to inheriting children only
- Entity - applies right to the item only
.PARAMETER SecurityPermission
The SecurityPermission determines whether to grant (allow) or deny the access right, and deny or allow inheritance of the right.
- AllowAccess -
- DenyAccess -
- AllowInheritance -
- DenyInheritance -
.PARAMETER AccessRight
The access right to grand or deny.
Well known rights are:
- field:read - "Field Read" - controls whether an account can read a specific field on an item..
- field:write - "Field Write" - controls whether an account can update a specific field on an item.
- item:read - "Read" - controls whether an account can see an item in the content tree and/or on the published Web site, including all of its properties and field values.
- item:write - "Write" - controls whether an account can update field values. The write access right requires the read access right and field read and field write access rights for individual fields (field read and field write are allowed by default).
- item:rename - "Rename" - controls whether an account can change the name of an item. The rename access right requires the read access right.
- item:create - "Create" - controls whether an account can create child items. The create access right requires the read access right.
- item:delete - "Delete" - Delete right for items. controls whether an account can delete an item. The delete access right requires the read access right
Important!
The Delete command also deletes all child items, even if the account has been denied Delete
rights for one or more of the subitems.
- item:admin - "Administer" - controls whether an account can configure access rights on an item. The administer access right requires the read and write access rights.
- language:read - "Language Read" - controls whether a user can read a specific language version of items.
- language:write - "Language Write" - controls whether a user can update a specific language version of items.
- site:enter - controls whether a user can access a specific site.
- insert:show - "Show in Insert" - Determines if the user can see the insert option
- workflowState:delete - "Workflow State Delete" - controls whether a user can delete items which are currently associated with a specific workflow state.
- workflowState:write - "Workflow State Write" - controls whether a user can update items which are currently associated with a specific workflow state.
- workflowCommand:execute - "Workflow Command Execute" - — controls whether a user is shown specific workflow commands.
- profile:customize - "Customize Profile Key Values" - The right to input out of range values of profile keys, that belong to this profile.
- bucket:makebucket - "Create Bucket" - convert item to bucket.
- bucket:unmake - "Revert Bucket" - convert item back from bucket.
- remote:fieldread - "Field Remote Read" - Field Read right for remoted clients.
.PARAMETER Identity
User name including domain for which the access rule is being created. If no domain is specified - 'sitecore' will be used as the default domain.
.PARAMETER Item
The item to be processed.
.PARAMETER Path
Path to the item to be processed.
.PARAMETER Id
Id of the item to be processed.
.PARAMETER Database
Database containing the item to be processed.
.PARAMETER Confirm
Prompts you for confirmation before running the cmdlet.
.PARAMETER WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
.INPUTS
Sitecore.Data.Items.Item1
# can be piped from another cmdlet
.OUTPUTS
Sitecore.Data.Items.Item2
# Only if -PassThru is used
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.LINK
Add-ItemAcl
.LINK
Clear-ItemAcl
.LINK
Get-ItemAcl
.LINK
New-ItemAcl
.LINK
Set-ItemAcl
.LINK
Test-ItemAcl
.LINK
https://sdn.sitecore.net/upload/sitecore6/security_administrators_cookbook_a4.pdf
.LINK
https://sdn.sitecore.net/upload/sitecore6/61/security_reference-a4.pdf
.LINK
https://sdn.sitecore.net/upload/sitecore6/64/content_api_cookbook_sc64_and_later-a4.pdf
.LINK
http://www.sitecore.net/learn/blogs/technical-blogs/john-west-sitecore-blog/posts/2013/01/sitecore-security-access-rights.aspx
.LINK
https://briancaos.wordpress.com/2009/10/02/assigning-security-to-items-in-sitecore-6-programatically/
.EXAMPLE
PS master:\> Add-ItemAcl -Path master:\content\home
#>
@@ -0,0 +1,44 @@
<#
.SYNOPSIS
Clear-ItemAcl.
.DESCRIPTION
Clear-ItemAcl.
.PARAMETER Language
If you need the item in specific Language You can specify it with this parameter. Globbing/wildcard supported.
.PARAMETER Item
The item to be processed.
.PARAMETER Path
Path to the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Id
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Database
Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER WhatIf
TODO: Provide description for this parameter
.PARAMETER Confirm
TODO: Provide description for this parameter
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
Sitecore.Data.Items.Item
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> Clear-ItemAcl -Path master:\content\home
#>
@@ -2,8 +2,8 @@
$documentation = Split-Path $Invocation
$rootDirectory = Split-Path $documentation -Parent
$help = Join-Path -Path $rootDirectory -ChildPath "sitecore modules\PowerShell\Assets"
$moduleLibraryPath = (Join-Path -Path $rootDirectory -ChildPath "bin\Debug\Cognifide.PowerShell.dll")
$help = Join-Path -Path $rootDirectory -ChildPath "Cognifide.PowerShell\sitecore modules\PowerShell\Assets"
$moduleLibraryPath = (Join-Path -Path $rootDirectory -ChildPath "Cognifide.PowerShell\bin\Debug\Cognifide.PowerShell.dll")
if(!(Test-Path -Path $moduleLibraryPath)) {
Write-Error "Module Library Path not found"
}
@@ -0,0 +1,44 @@
<#
.SYNOPSIS
Get-ItemAcl.
.DESCRIPTION
Get-ItemAcl.
.PARAMETER Identity
User name including domain. If no domain is specified - 'sitecore' will be used as the default value
.PARAMETER Filter
TODO: Provide description for this parameter
.PARAMETER Item
The item to be processed.
.PARAMETER Path
Path to the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Id
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Database
Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Language
If you need the item in specific Language You can specify it with this parameter. Globbing/wildcard supported.
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
Sitecore.Security.AccessControl.AccessRule
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> Get-ItemAcl -Path master:\content\home
#>
@@ -0,0 +1,35 @@
<#
.SYNOPSIS
New-ItemAcl.
.DESCRIPTION
New-ItemAcl.
.PARAMETER Identity
User name including domain. If no domain is specified - 'sitecore' will be used as the default value
.PARAMETER PropagationType
TODO: Provide description for this parameter
.PARAMETER SecurityPermission
TODO: Provide description for this parameter
.PARAMETER AccessRight
TODO: Provide description for this parameter
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
Sitecore.Security.AccessControl.AccessRule
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> New-ItemAcl -Path master:\content\home
#>
@@ -0,0 +1,38 @@
<#
.SYNOPSIS
New-SecuritySource.
.DESCRIPTION
New-SecuritySource.
.PARAMETER Account
TODO: Provide description for this parameter
.PARAMETER Identity
User name including domain. If no domain is specified - 'sitecore' will be used as the default value
.PARAMETER Filter
TODO: Provide description for this parameter
.PARAMETER AccountType
TODO: Provide description for this parameter
.PARAMETER Name
TODO: Provide description for this parameter
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
Sitecore.Install.Security.SecuritySource
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> New-SecuritySource -Path master:\content\home
#>
@@ -0,0 +1,29 @@
<#
.SYNOPSIS
Remove-ScriptSession.
.DESCRIPTION
Remove-ScriptSession.
.PARAMETER Id
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Session
TODO: Provide description for this parameter
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> Remove-ScriptSession -Path master:\content\home
#>
@@ -0,0 +1,47 @@
<#
.SYNOPSIS
Set-ItemAcl.
.DESCRIPTION
Set-ItemAcl.
.PARAMETER AccessRules
TODO: Provide description for this parameter
.PARAMETER Language
If you need the item in specific Language You can specify it with this parameter. Globbing/wildcard supported.
.PARAMETER Item
The item to be processed.
.PARAMETER Path
Path to the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Id
Id of the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER Database
Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
.PARAMETER WhatIf
TODO: Provide description for this parameter
.PARAMETER Confirm
TODO: Provide description for this parameter
.INPUTS
Sitecore.Data.Items.Item
.OUTPUTS
Sitecore.Data.Items.Item
.NOTES
Help Author: Adam Najmanowicz, Michael West
.LINK
https://github.com/SitecorePowerShell/Console/
.EXAMPLE
PS master:\> Set-ItemAcl -Path master:\content\home
#>
Oops, something went wrong.

0 comments on commit ab60a63

Please sign in to comment.