Skip to main content

Get-AtriaWorkSpaceCustomerRole

SYNOPSIS​

Retrieves one or more roles associated with a customer.

SYNTAX​

Get-AtriaWorkSpaceCustomerRole -CustomerId <Int> [-RoleId <Int>] [<CommonParameters>]

DESCRIPTION​

Queries the Atria API for roles linked to a customer within the WorkSpace service. This function can return all roles or filter by a specific role ID.

PARAMETERS​

  • CustomerId <Int> (Required) The unique identifier of the customer whose roles are being queried.

  • RoleId <Int> (Optional) Filters the results to only include the role with the specified ID.

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

OUTPUTS​

Returns a list of role objects (or a filtered single result) retrieved from the Atria WorkSpace API.

EXAMPLES​

Example 1 - Get all roles​

Get-AtriaWorkSpaceCustomerRole -CustomerId 1234

Returns all roles assigned to customer ID 1234.

Example 2 - Get specific role by ID​

Get-AtriaWorkSpaceCustomerRole -CustomerId 1234 -RoleId 789

Returns the role with ID 789 for customer 1234.

NOTES​

Make sure you call Connect-AtriaApi before using this function.