New-FilesPermission
Create Permission.
Syntax
Description
Create Permission.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
Examples
Example 1: Create Permission
Writes the permission returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Path
Folder path
- Type:
System.String - Parameter sets:
(All)(required)
-GroupId
Group ID. Provide group_name or group_id
- Type:
System.Int64 - Parameter sets:
(All)
-GroupIds
Group IDs when the Permission requires membership in every listed group. If sent as a string, it should be comma-delimited. Give the values as an array; the module joins them as the API expects.
- Type:
System.Int64[] - Parameter sets:
(All)
-Permission
Permission type. Can be admin, full, readonly, writeonly, list, or history
- Type:
System.String - Parameter sets:
(All)
-Recursive
Apply to subfolders recursively? Must be true for admin Permissions.
- Type:
System.Boolean - Parameter sets:
(All)
-PartnerId
Partner ID if this Permission belongs to a partner.
- Type:
System.Int64 - Parameter sets:
(All)
-UserId
User ID. Provide username or user_id
- Type:
System.Int64 - Parameter sets:
(All)
-Username
User username. Provide username or user_id
- Type:
System.String - Parameter sets:
(All)
-GroupName
Group name. Provide group_name or group_id
- Type:
System.String - Parameter sets:
(All)
-SiteId
Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
- Type:
System.Int64 - Parameter sets:
(All)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: High. At the default
$ConfirmPreferenceofHigh, the command asks before each change;-Confirm:$falseruns it without asking.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.Permission: the permission as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.