Skip to main content

Set-AtriaWorkSpaceUserItem

SYNOPSIS​

Sets the complete list of workspace items assigned to a specific user.

SYNTAX​

Set-AtriaWorkSpaceUserItem -CustomerId <Int> -UserId <Int> [-ListitemId <String[]>] [<CommonParameters>]

DESCRIPTION​

Overwrites the list of assigned workspace items for a user in a customer context. This API call removes all previous assignments and replaces them with the ones provided. Use an empty array to clear all assigned items.

PARAMETERS​

  • CustomerId <Int> (Required) The unique identifier (ID) of the customer to which the user belongs.

  • UserId <Int> (Required) The unique identifier (ID) of the user whose assigned items will be set.

  • ListitemId <String[]> (Optional) A list of workspace item IDs to assign. An empty array clears all assignments.

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

OUTPUTS​

Returns the API response confirming the update.

EXAMPLES​

Example 1​

Set-AtriaWorkSpaceUserItem -CustomerId 1234 -UserId 5678 -ListitemId 1001,1002

Assigns only items 1001 and 1002 to user 5678 under customer 1234.

Example 2​

Set-AtriaWorkSpaceUserItem -CustomerId 1234 -UserId 5678 -ListitemId @()

Removes all list item assignments from user 5678.

NOTES​

Ensure you've authenticated using Connect-AtriaApi before invoking this function.