Skip to main content

New-AtriaWorkSpaceCustomerRole

SYNOPSIS​

Creates a new role for a specific customer.

SYNTAX​

New-AtriaWorkSpaceCustomerRole -customerId <Int> -name <String> [-sortOrder <Int>] [<CommonParameters>]

DESCRIPTION​

This function adds a new workspace role for the specified customer using the Atria API. Roles are typically used to group users and manage access to workspace items in bulk.

PARAMETERS​

  • customerId <Int> (Required) The ID of the customer to which the new role will be assigned.

  • name <String> (Required) The name of the role to be created.

  • sortOrder <Int> (Optional) The display order of the role among other roles. Lower numbers are displayed earlier.

  • <CommonParameters> Supports common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. More info: about_CommonParameters.

EXAMPLES​

Example 1 - Create a basic role​

New-AtriaWorkSpaceCustomerRole -customerId 456 -name "SupportUser"

Creates a workspace role called SupportUser for customer ID 456.

Example 2 - Create a sorted role​

New-AtriaWorkSpaceCustomerRole -customerId 456 -name "Admin" -sortOrder 10

Creates a role called Admin for customer ID 456 and ensures it appears in the 10th position.

OUTPUTS​

Returns the created role object as defined by the Atria API.

NOTES​

You must call Connect-AtriaApi before using this function to ensure authenticated API access.