New-FilesPartner

Create Partner.

Syntax

New-FilesPartner [-AiAssistantPersonalityId <System.Int64>] [-AllowedIps <System.String[]>] [-AllowBypassing2faPolicies <System.Boolean>] [-AllowCredentialChanges <System.Boolean>] [-AllowProvidingGpgKeys <System.Boolean>] [-AllowUserCreation <System.Boolean>] [-CcEmailsToResponsibleParty <System.Boolean>] [-Notes <System.String>] [-PartnerChannelTemplateId <System.Int64>] [-ResponsibleGroupId <System.Int64>] [-ResponsibleUserId <System.Int64>] [-ShowPartnerChannelHomePage <System.Boolean>] [-Tags <System.String[]>] -Name <System.String> -RootFolder <System.String> [-WorkspaceId <System.Int64>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Partner.

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 Partner

New-FilesPartner -Name 'Acme Corp' -RootFolder '/AcmeCorp' -AiAssistantPersonalityId 1 -AllowedIps '10.0.0.0/8', '127.0.0.1'

Writes the partner returned.

Example 2: Preview the change

New-FilesPartner -Name 'Acme Corp' -RootFolder '/AcmeCorp' -AiAssistantPersonalityId 1 -AllowedIps '10.0.0.0/8', '127.0.0.1' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-AiAssistantPersonalityId

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

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

-AllowedIps

A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists. Give the values as an array; the module joins them as the API expects.

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

-AllowBypassing2faPolicies

Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.

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

-AllowCredentialChanges

Allow Partner Admins to change or reset credentials for users belonging to this Partner.

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

-AllowProvidingGpgKeys

Allow Partner Admins to provide GPG keys.

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

-AllowUserCreation

Allow Partner Admins to create users.

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

-CcEmailsToResponsibleParty

When true, emails sent to Partner users are copied to the responsible User or Group.

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

-Notes

Notes about this Partner.

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

-PartnerChannelTemplateId

ID of the Partner Channel Template assigned to this Partner.

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

-ResponsibleGroupId

ID of the Group responsible for this Partner.

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

-ResponsibleUserId

ID of the User responsible for this Partner.

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

-ShowPartnerChannelHomePage

Show Partner users a simplified home page built from this Partner's Channels.

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

-Tags

Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens. Give the values as an array; the module joins them as the API expects.

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

-Name

The name of the Partner.

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

-RootFolder

The root folder path for this Partner.

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

-WorkspaceId

ID of the Workspace associated with this Partner.

  • 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.Partner: the partner 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.