< Back
New-AMPermission
Post
NAME New-AMPermission
SYNOPSIS
Assigns security to an AutoMate Enterprise object.
SYNTAX
New-AMPermission [-InputObject] <Object> [[-Principal] <Object>] [-FullControl] [-Create] [-Read] [-Edit]
[-Delete] [-DeleteRevisionFromRecycleBin] [-DeleteRevision] [-RestoreRevisionFromRecycleBin] [-RestoreRevision]
[-Move] [-ToggleEnable] [-ManualRun] [-Stop] [-Import] [-Export] [-Staging] [-Assign] [-ChangeSecurity]
[-ManualResume] [-ManualRunFromHere] [-ToggleLock] [-UpdateRevision] [-Upgrade] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
New-AMPermission assigns security to an object.
PARAMETERS
-InputObject <Object>
The object to apply security to.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Principal <Object>
The user or group to assign security to.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullControl [<SwitchParameter>]
Allow or deny full control on the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Create [<SwitchParameter>]
Allow or deny creating the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Read [<SwitchParameter>]
Allow or deny permission to view the object's properties.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Edit [<SwitchParameter>]
Allow or deny permission to modify the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Delete [<SwitchParameter>]
Allow or deny permission to delete the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeleteRevisionFromRecycleBin [<SwitchParameter>]
Allow or deny permission to delete from the Recycle Bin.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeleteRevision [<SwitchParameter>]
Allow or deny permission to delete a revision.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RestoreRevisionFromRecycleBin [<SwitchParameter>]
Allow or deny permission to restore from the Recycle Bin.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RestoreRevision [<SwitchParameter>]
Allow or deny permission to restore a previous version of the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Move [<SwitchParameter>]
Allow or deny permission to move the object from its original folder to another folder.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ToggleEnable [<SwitchParameter>]
Allow or deny permission to enable this object if it is currently disabled.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualRun [<SwitchParameter>]
Allow or deny permission to manually run the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Stop [<SwitchParameter>]
Allow or deny permission to manually stop the object when it is running.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Import [<SwitchParameter>]
Allow or deny permission to import the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Export [<SwitchParameter>]
Allow or deny permission to export the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Staging [<SwitchParameter>]
Allow or deny staging for the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Assign [<SwitchParameter>]
Allow or deny permission to assign the object to a workflow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ChangeSecurity [<SwitchParameter>]
Allow or deny permission to modify the security (permissions) settings of the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualResume [<SwitchParameter>]
Allow or deny the object to resume execution from where it last encountered an error.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualRunFromHere [<SwitchParameter>]
Allow or deny permission to manually run the object from the specified step or workflow location.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ToggleLock [<SwitchParameter>]
Allow or deny permission to lock an object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UpdateRevision [<SwitchParameter>]
Allow or deny permission to update a revision.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Upgrade [<SwitchParameter>]
Undocumented permission.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># Denies user 'John' access to task 'Test'
Get-AMTask -Name "Test" | New-AMPermission -Principal "John"
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Assigns security to an AutoMate Enterprise object.
SYNTAX
New-AMPermission [-InputObject] <Object> [[-Principal] <Object>] [-FullControl] [-Create] [-Read] [-Edit]
[-Delete] [-DeleteRevisionFromRecycleBin] [-DeleteRevision] [-RestoreRevisionFromRecycleBin] [-RestoreRevision]
[-Move] [-ToggleEnable] [-ManualRun] [-Stop] [-Import] [-Export] [-Staging] [-Assign] [-ChangeSecurity]
[-ManualResume] [-ManualRunFromHere] [-ToggleLock] [-UpdateRevision] [-Upgrade] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
New-AMPermission assigns security to an object.
PARAMETERS
-InputObject <Object>
The object to apply security to.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Principal <Object>
The user or group to assign security to.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullControl [<SwitchParameter>]
Allow or deny full control on the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Create [<SwitchParameter>]
Allow or deny creating the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Read [<SwitchParameter>]
Allow or deny permission to view the object's properties.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Edit [<SwitchParameter>]
Allow or deny permission to modify the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Delete [<SwitchParameter>]
Allow or deny permission to delete the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeleteRevisionFromRecycleBin [<SwitchParameter>]
Allow or deny permission to delete from the Recycle Bin.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DeleteRevision [<SwitchParameter>]
Allow or deny permission to delete a revision.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RestoreRevisionFromRecycleBin [<SwitchParameter>]
Allow or deny permission to restore from the Recycle Bin.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RestoreRevision [<SwitchParameter>]
Allow or deny permission to restore a previous version of the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Move [<SwitchParameter>]
Allow or deny permission to move the object from its original folder to another folder.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ToggleEnable [<SwitchParameter>]
Allow or deny permission to enable this object if it is currently disabled.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualRun [<SwitchParameter>]
Allow or deny permission to manually run the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Stop [<SwitchParameter>]
Allow or deny permission to manually stop the object when it is running.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Import [<SwitchParameter>]
Allow or deny permission to import the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Export [<SwitchParameter>]
Allow or deny permission to export the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Staging [<SwitchParameter>]
Allow or deny staging for the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Assign [<SwitchParameter>]
Allow or deny permission to assign the object to a workflow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ChangeSecurity [<SwitchParameter>]
Allow or deny permission to modify the security (permissions) settings of the object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualResume [<SwitchParameter>]
Allow or deny the object to resume execution from where it last encountered an error.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ManualRunFromHere [<SwitchParameter>]
Allow or deny permission to manually run the object from the specified step or workflow location.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ToggleLock [<SwitchParameter>]
Allow or deny permission to lock an object.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-UpdateRevision [<SwitchParameter>]
Allow or deny permission to update a revision.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Upgrade [<SwitchParameter>]
Undocumented permission.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># Denies user 'John' access to task 'Test'
Get-AMTask -Name "Test" | New-AMPermission -Principal "John"
RELATED LINKS
https://github.com/AutomatePS/AutomatePS