New-FilesGroup

Create Group.

Syntax

New-FilesGroup [-Notes <System.String>] [-UserIds <System.Int64[]>] [-AdminIds <System.Int64[]>] [-AiAssistantPersonalityId <System.Int64>] [-FtpPermission <System.Boolean>] [-SftpPermission <System.Boolean>] [-DavPermission <System.Boolean>] [-RestapiPermission <System.Boolean>] [-S3CompatibleEndpointPermission <System.Boolean>] [-DesktopConfigurationProfileId <System.Int64>] [-IntegrationCentricProfileId <System.Int64>] [-AllowedIps <System.String[]>] -Name <System.String> [-WorkspaceId <System.Int64>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Group.

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 Group

New-FilesGroup -Name 'name' -AiAssistantPersonalityId 1 -FtpPermission $true

Writes the group returned.

Example 2: Preview the change

New-FilesGroup -Name 'name' -AiAssistantPersonalityId 1 -FtpPermission $true -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Notes

Group notes.

  • Type: System.String
  • Parameter sets: (All)

-UserIds

A list of user ids. If sent as a string, should be comma-delimited. Give the values as an array; the module joins them as the API expects.

  • Type: System.Int64[]
  • Parameter sets: (All)

-AdminIds

A list of group admin user ids. If sent as a string, should be comma-delimited. Give the values as an array; the module joins them as the API expects.

  • Type: System.Int64[]
  • Parameter sets: (All)

-AiAssistantPersonalityId

AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.

  • Type: System.Int64
  • Parameter sets: (All)

-FtpPermission

If true, users in this group can use FTP to login. This will override a false value of ftp_permission on the user level.

  • Type: System.Boolean
  • Parameter sets: (All)

-SftpPermission

If true, users in this group can use SFTP to login. This will override a false value of sftp_permission on the user level.

  • Type: System.Boolean
  • Parameter sets: (All)

-DavPermission

If true, users in this group can use WebDAV to login. This will override a false value of dav_permission on the user level.

  • Type: System.Boolean
  • Parameter sets: (All)

-RestapiPermission

If true, users in this group can use the REST API to login. This will override a false value of restapi_permission on the user level.

  • Type: System.Boolean
  • Parameter sets: (All)

-S3CompatibleEndpointPermission

If true, users in this group can access the S3-compatible endpoint. This will override a false value of s3_compatible_endpoint_permission on the user level. Defaults to false.

  • Type: System.Boolean
  • Parameter sets: (All)

-DesktopConfigurationProfileId

Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.

  • Type: System.Int64
  • Parameter sets: (All)

-IntegrationCentricProfileId

Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.

  • Type: System.Int64
  • Parameter sets: (All)

-AllowedIps

A list of allowed IPs if applicable. Newline delimited Give the values as an array; the module joins them as the API expects.

  • Type: System.String[]
  • Parameter sets: (All)

-Name

Group name.

  • Type: System.String
  • Parameter sets: (All) (required)

-WorkspaceId

Workspace ID

  • 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 $ConfirmPreference of High, the command asks before each change; -Confirm:$false runs 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.Group: the group 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.