Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Version: 1.19.0 (latest)

The following table lists the permissions and descriptions of each permission.

NameDescription
UserDefault level of permissions for normal users.
Global AdminGlobal Administrator with all permissions.
Users ViewView users and user information.
Users ModifyModify existing users.
Users CreateCreate new users.
Users DeleteDelete exiting users.
Users Modify AdminModify users with Global Admin permissions.
Users Auth SessionLogin and logout on behalf of another user.
Groups ViewView groups, group members, and group settings.
Groups ModifyModify group members and settings.
Groups CreateCreate new groups.
Groups DeleteDelete existing groups.
Groups View IfMemberView groups you are a member of, excluding system groups.
Groups Modify IfMemberModify groups you are a member of, excluding system groups.
Groups View SystemView groups, group members and group settings of system defined groups.
Groups Modify SystemModify group members and settings of system groups.
Groups Delete SystemDelete a system group.
Agents ViewView agents and agent settings.
Agents ModifyModify agent settings.
Agents CreateCreate agents.
Agents DeleteDelete existing agents.
Staging ViewView staging list and stage configuration settings.
Staging ModifyModify existing staging settings.
Staging CreateCreate new staging configurations.
Staging DeleteDelete existing staging configurations.
Casting ViewView casting list and casting configuration settings.
Casting ModifyModify existing casting settings.
Casting CreateCreate new casting configurations.
Casting DeleteDelete existing casting configurations.
Sessions ViewView all user sessions.
Sessions ModifyPerform modifications to a session of another user.
Sessions DeleteDelete the session of another user.
Session Recordings ViewView user session recordings.
Images ViewView images
Images ModifyModify image configurations.
Images CreateCreate new images.
Images DeleteDelete existing images.
Images Modify ResourcesModify image resource settings, such as CPU and Memory settings.
DevAPI ViewView developer API list.
DevAPI ModifyModify developer API configurations.
DevAPI CreateCreate a new developer API key.
DevAPI DeleteDelete an existing developer API key.
Webfilters ViewView webfilters
Webfilters ModifyModify existing webfilters
Webfilters CreateCreate a new webfilter.
Webfilters DeleteDelete an existing webfilter
Brandings ViewView branding configurations.
Brandings ModifyModify existing branding configurations.
Brandings CreateCreate new branding configurations.
Brandings DeleteDelete existing branding configurations.
Settings ViewView global settings.
Settings ModifyModify global settings in all categories.
Settings Modify AuthModify global settings in the authentication category.
Settings Modify Auth CaptchaModify global settings in the authentication captcha category.
Settings Modify CastModify global settings in the casting category.
Settings Modify ImagesModify global settings in the images category.
Settings Modify LicenseModify global settings in the license category.
Settings Modify LoggingModify global settings in the logging category.
Settings Modify ManagerModify global settings in the manager category.
Settings Modify ScaleModify global settings in the scale category.
Settings Modify SubscriptionModify global settings in the subscription category.
Settings Modify FilterModify global settings in the filter category.
Settings Modify StorageModify global settings in the storage category.
Settings Modify ConnectionsModify global settings in the connections category.
Settings Modify ThemeModify global settings in the theme category.
Auth ViewView LDAP/OIDC/SAML configurations.
Auth ModifyModify LDAP/OIDC/SAML configurations.
Auth CreateCreate LDAP/OIDC/SAML configurations.
Auth DeleteDelete LDAP/OIDC/SAML configurations.
Licenses ViewView licenses.
Licenses CreateAdd new licenses.
Licenses DeleteDelete licenses.
System ViewView system information.
System Export SchemaExport system schema.
System Import DataImport system data.
System Export DataExport system data.
Reports ViewView system reports and logging. Warning: Providing access to logs can provide a lot of potentially sensitive information.
Managers ViewView the managers.
Managers ModifyModify existing managers.
Managers CreateCreate a new manager.
Managers DeleteDelete existing managers.
Zones ViewView Zones and Zone settings.
Zones ModifyModify Zone settings.
Zones CreateCreate new Zones.
Zones DeleteDelete existing Zones.
Companies ViewView companies.
Companies ModifyModify existing company.
Companies CreateCreate a new company.
Companies DeleteDelete an existing company.
Connection Proxy ViewView connection proxies.
Connection Proxy ModifyModify connection proxies.
Connection Proxy CreateCreate a connection proxy.
Connection Proxy DeleteDelete an existing connection proxy.
Physical Tokens ViewView physical 2FA tokens.
Physical Tokens ModifyAssign/Unassign physical 2FA tokens.
Physical Tokens CreateImport or create physical 2FA tokens.
Physical Tokens DeleteDelete a physical 2FA token.
Servers ViewView servers.
Servers ModifyModify existing servers.
Servers CreateCreate new servers.
Servers DeleteDelete servers.
Server Pools ViewView server pools.
Server Pools ModifyModify server pools.
Server Pools CreateCreate a new server pool.
Server Pools DeleteDelete a server pool.
Autoscale ViewView auto scale configurations.
Autoscale ModifyModify an existing auto scale configuration.
Autoscale CreateCreate a new auto scale configuration.
Autoscale DeleteDelete auto scale configurations.
VM Provider ViewView VM Provider configurations.
VM Provider ModifyModify VM Provider configurations.
VM Provider CreateCreate new VM Provider configurations.
VM Provider DeleteDelete VM Provider configurations.
Autoscale Schedule ViewView an auto scale schedule.
Autoscale Schedule ModifyModify an auto scale schedule.
Autoscale Schedule CreateCreate an auto scale schedule.
Autoscale Schedule DeleteDelete an auto scale schedule.
DNS Providers ViewView DNS provider configurations.
DNS Providers ModifyModify DNS provider configurations.
DNS Providers CreateCreate new DNS Provider configurations.
DNS Providers DeleteDelete DNS Provider configurations.
Registries ViewView Workspace Registries.
Registries ModifyModify existing Workspace Registries.
Registries CreateAdd new Workspace Registries
Registries DeleteDelete a Workspace Registry
Storage Providers ViewView Storage Providers.
Storage Providers ModifyModify existing Storage Providers.
Storage Providers CreateCreate new Storage Providers.
Storage Providers DeleteDelete an existing Storage Provider.
Egress Providers ViewView Egress Providers.
Egress Providers ModifyModify existing Egress Providers.
Egress Providers CreateCreate new Egress Providers.
Egress Providers DeleteDelete an existing Egress Provider.
Egress Gateways ViewView Egress Gateways.
Egress Gateways ModifyModify existing Egress Gateways.
Egress Gateways CreateCreate new Egress Gateways.
Egress Gateways DeleteDelete an existing Egress Gateway.
Egress Credentials ViewView Egress Credentials.
Egress Credentials ModifyModify existing Egress Credentials.
Egress Credentials CreateCreate new Egress Credentials.
Egress Credentials DeleteDelete an existing Egress Credential.
Banners ViewView banners.
Banners ModifyModify existing banners.
Banners CreateCreate new banners.
Banners DeleteDelete an existing banner.
AD User Management ViewView AD User Management Configurations.
AD User Management ModifyModify existing AD User Management Configurations.
AD User Management CreateCreate new AD User Management Configurations.
AD User Management DeleteDelete an existing AD User Management Configuration.

Permission Changes​

A user's permissions are embedded in their session token, which is generated on login. A user's token lifetime is controlled by the Session Lifetime global setting. The UI will get a new session token every 5 minutes. The fastest way to get new permissions to apply, is to have the user log out and log back in, otherwise, the change will apply generally within 5 minutes.

Permission Dependencies​

While most permissions can stand alone, there are dependencies between some permissions. Generally, a Modify, Create, and/or Delete permission will need the corresponding View permission. The following are additional permission dependencies, which means you will need to grant multiple permissions to have the desired effect.

  • Licenses View requires System View
  • Permissions View requires Groups View
  • Registries View requires Images View, System View, and Agents View
  • Autoscale View requires Server Pools View
  • Autoscale Schedule View requires Server Pools View
  • DNS Providers View requires Server Pools View
  • VM Providers View requires Server Pools View and Autoscale View
  • Users Delete requires Sessions Delete if the target user has running sessions and Users Modify
  • Users Delete requires Users Modify Admin to delete a user that has the Global Admin permission
  • Egress Gateways Create, Egress Gateways Modify, Egress Gateways Delete, Egress Credentials Create, Egress Credentials Modify and Egress Credentials Delete require Egress Providers Modify.
  • Servers View and Server Templates View requires Server Pools View and Zones View

There are many cases where multiple permissions are not required, however, certain UI elements will be hidden if the user does not have the permissions to view them. For example, a user may have permissions to View Images, however, they may not have permissions to View Servers. If the user goes to view an individual Workspace Image that targets a Server, they will not see the drop down to view or edit the server the image is targeting.

Special Permissions​

There are more available permissions around groups, beyond the basic View, Create, Modify, and Delete. The Groups View IfMember and Groups Modify IfMember allow a user to view or modify a group if they are a member of that group. This does not extend to built-in system groups (All Users and Administrator). To edit or view System groups, they will also need the Groups View/Modify System permission.

There is an additional permission that protects modification of users with the Global Admin permission. In order to modify a Global Admin, the user requesting the modification must themselves be a Global Admin or have the User Modify Admin permission.

There are two permissions that allow modifications to Workspace Images, Images Modify and Images Modify Resources. The Images Modify allows modification of all Image settings except those that would modify the physical/virtual compute resources. The following settings require the Images Modify Resources permission to edit:

  • GPU Count
  • Cores
  • Memory
  • CPU Allocation Method
  • Uncompressed Image Size
  • Docker Registry
  • Docker Registry Username
  • Docker Registry Password
  • Hash
  • Volume Mappings
  • Docker Run Config Override
  • Docker Exec Config