WorkSpace PowerShell cmdlets

The Atria WorkSpace service includes a REST API and a set of Atria.Tools cmdlets for common automation tasks.

This section documents the PowerShell cmdlets. For operations or fields that are not exposed by a cmdlet, use the Atria REST API Reference.

Your own Atria instance also exposes its Swagger UI at:

https://{hostname}/api/

note

Call Connect-AtriaApi before using these commands. Use IDs returned by the Get-* commands; WorkSpace item, list, role, customer, and user IDs are different identifiers and are not interchangeable.

Connect to the API

Connecting validates the bearer token against /api/v2/me and stores the API base URI and identity context for later cmdlets.

• Connect-AtriaApi
  Validates a bearer token and configures the Atria.Tools REST API session.

• Disconnect-AtriaApi
  Clears the bearer token and identity context stored by Atria.Tools.

• Get-AtriaApiContext
  Retrieves the current Atria.Tools API connection context.

Work with item types

Item types are retrieved through the API. Creating or changing an item type is not exposed by these cmdlets. Do not edit the Atria database directly; contact Atria Support or Consulting when a deployment requires a new item type.

• Get-AtriaWorkSpaceItemType
  Retrieves the WorkSpace Item Types.

Shared items

• Add-AtriaWorkSpaceItemCustomerRelationship
  Makes a WorkSpace item available to a customer.

• Get-AtriaWorkSpaceItem
  Retrieves one or more workspace shared items.

• Get-AtriaWorkSpaceItemCustomerRelationship
  Retrieves a list of customers related to a specific item.

• Get-AtriaWorkSpaceItemRoleRelationship
  Retrieves the list of roles that are linked to a specific workspace item.

• Get-AtriaWorkSpaceItemUserRelationship
  Retrieves the list of users associated with a specific workspace item.

• New-AtriaWorkSpaceItem
  Creates a new Shared (Public) WorkSpace Item.

• Remove-AtriaWorkSpaceItemCustomerRelationship
  Removes the relationship between a workspace item and a customer.

Customer-owned items

• Add-AtriaWorkSpaceCustomerItem
  Assigns a workspace item from a list to a customer in the Atria workspace service

• Get-AtriaWorkSpaceCustomerItem
  Retrieves workspace items assigned to a specific customer.

• Get-AtriaWorkSpaceItemRoleRelationship
  Retrieves the list of roles that are linked to a specific workspace item.

• Get-AtriaWorkSpaceItemUserRelationship
  Retrieves the list of users associated with a specific workspace item.

• Import-AtriaWorkSpaceCustomerItem
  Imports existing directory-backed WorkSpace items for a customer.

• New-AtriaWorkSpaceCustomerItem
  Creates a customer-owned WorkSpace item.

• Remove-AtriaWorkSpaceCustomerItem
  Removes a workspace item assigned to a specific customer.

• Update-AtriaWorkSpaceCustomerItem
  Updates metadata or membership for a customer's WorkSpace item.

Lists and scopes

• Add-AtriaWorkSpaceListItem
  Adds a shared workspace item to a specific workspace list

• Add-AtriaWorkSpaceListScope
  Assigns a scope for a workspace list to a customer

• Get-AtriaWorkSpaceItemListRelationship
  Retrieves a list of WorkSpace Lists an item is allocated to.

• Get-AtriaWorkSpaceList
  Retrieves one or more WorkSpace Lists.

• Get-AtriaWorkSpaceListItem
  Retrieves items from a specified workspace list.

• Get-AtriaWorkSpaceListScope
  Retrieves scopes associated with a specific workspace list

• Remove-AtriaWorkSpaceListItem
  Removes a shared workspace item from a specific workspace list

Icons

• Get-AtriaWorkSpaceIcon
  Retrieves an icon associated with a workspace item.

Roles and assignments

• Add-AtriaWorkSpaceCustomerRoleItem
  Adds one or more workspace list items to a specific customer role

• Get-AtriaWorkSpaceCustomerRole
  Retrieves one or more roles associated with a customer.

• Get-AtriaWorkSpaceCustomerRoleItem
  Retrieves workspace items associated with a specific customer role.

• Get-AtriaWorkSpaceItemRoleRelationship
  Retrieves the list of roles that are linked to a specific workspace item.

• Get-AtriaWorkSpaceUserRole
  Retrieves roles assigned to a specific user.

• New-AtriaWorkSpaceCustomerRole
  Creates a new role for a specific customer.

• Remove-AtriaWorkSpaceCustomerRoleItem
  Removes one or more workspace list items from a specific customer role.