Skip to main content

Add-AtriaWorkSpaceListScope

SYNOPSIS​

Assigns a scope for a workspace list to a customer.

SYNTAX​

Add-AtriaWorkSpaceListScope -ListId <Int> -CustomerId <Int> -Scope <String> [<CommonParameters>]

DESCRIPTION​

Creates a scope association between a workspace list and a customer, defining the scope at which list items become available to the customer. Supported scope values are Self, Child, and SelfAndChild.

PARAMETERS​

  • ListId <Int> (Required) The unique identifier (ID) of the workspace list.

  • CustomerId <Int> (Required) The unique identifier (ID) of the customer to whom the list scope will be applied.

  • Scope <String> (Required) Defines how the workspace list items are scoped. Valid values are:

    • Self: Only the specified customer has access.
    • Child: Only child entities of the specified customer have access.
    • SelfAndChild: Both the specified customer and their child entities have access.

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

    More info: about_CommonParameters.

OUTPUTS​

Returns the response object confirming the successful scope assignment.

EXAMPLES​

Example 1 (Self scope)​

PS> Add-AtriaWorkSpaceListScope -ListId 1001 -CustomerId 2002 -Scope 'Self'

Assigns a 'Self' scope, granting customer ID 2002 direct access to workspace list ID 1001.

Example 2 (Self and Child scope)​

PS> Add-AtriaWorkSpaceListScope -ListId 1001 -CustomerId 2002 -Scope 'SelfAndChild'

Assigns a 'SelfAndChild' scope, making workspace list ID 1001 available to customer ID 2002 and all their child entities.

NOTES​

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