Skip to main content

Remove-AtriaWorkSpaceCustomerRoleItem

SYNOPSIS​

Removes one or more workspace list items from a specific customer role.

SYNTAX​

Remove-AtriaWorkSpaceCustomerRoleItem -CustomerId <Int> -RoleId <Int> -ListItemId <Int[]> [<CommonParameters>]

DESCRIPTION​

This function sends a request to the Atria workspace service to remove one or more list items from a specified role under a given customer. It uses a POST method with an action="Remove" payload.

PARAMETERS​

  • CustomerId <Int> (Required) The unique identifier of the customer that owns the role.

  • RoleId <Int> (Required) The unique identifier of the role from which the list items will be removed.

  • ListItemId <Int[]> (Required) One or more workspace list item IDs to be removed from the specified role.

  • <CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

OUTPUTS​

Returns the API response confirming the role-item removal.

EXAMPLES​

Example 1​

Remove-AtriaWorkSpaceCustomerRoleItem -CustomerId 1234 -RoleId 101 -ListItemId 501,502

Removes list items with IDs 501 and 502 from role 101 under customer 1234.

NOTES​

Ensure you are authenticated with Connect-AtriaApi before using this function.