in beta
enterprise plans
If you have environments such as Dev, Staging, QA, and Prod you can specify what users can do in the different environments. For example, you might want some users to focus on certain environments and designate who can push from one environment to another.
This document covers the available environment permissions that you can set in Builder.
To get the most out of this tutorial, you should meet the following:
- Have Builder Admin permissions in a space with an Enterprise plan
- Have more than one environment
- Have read Enabling Environments for a Space
- Have read Roles and Permissions and Custom Roles.
When you create an environment, Builder copies all the existing users and their permissions from the original environment into the new environment.
If your environments already exist before you create a user, you must add that user to the appropriate environment(s) and assign them a role.
Additionally, you can use custom roles to specify which permissions a user has in a particular environment.
For more detail on permissions in general, see Roles and Permissions and Custom Roles.
To customize a role specific to a non-main environment:
- In the Account Settings Environments tab, enter the environment where you'd like to apply the environment-related permissions. It must be an environment other than your main environment.
- Within that environment, go to Account Settings.
- Click the pencil icon to the right of Roles.
- Open an existing role or add a new role, depending on your use case.
- With the role expanded, scroll to the Environment Access section. This section only shows for Enterprise plans, and only in non-main environments.
- Select the options as appropriate.
The available environment-related permissions are:
- Allow linking: allows users to link or unlink content from an environment. For more information on linking and Live Sync, see Syncing environments with Live Sync.
- Push content/models: allows users to push content and models from this environment to all other environments. To limit this access, uncheck this option to show a list of your environments and check only the environments that you want that role to be able to push to. If a role does not grant permission to push, users can request to push. For more detail on what pushing means, see Pushing changes from a child environment.
The following video demonstrates this process:
For more detail on permissions in general, see Roles and Permissions and Custom Roles.
Adding a user to a non-main environment is identical to adding a user to a space without environments with the only difference being that you need to explicitly add the user to the non-main environment that you'd like them to work in.
To add a user to an environment:
- In the Account Settings Environments tab, enter the environment that you'd like the user to access. It must be an environment other than your main environment.
- Within that environment, go to Account Settings > Users.
- Click the Add New User button.
- Add the new user by filling out the dialogue and clicking the Create button.
Builder sends the new user an email with instructions for activating the new access.
The following video demonstrates this process:
For more detail on permissions in general, see Roles and Permissions and Custom Roles.
If you have users who don't have access to push but who have completed work and are ready for that work to move to the next environment, they can request that an Admin push.
To request a push as the user with restricted access:
- In the environment from which you would like to push, open the content entry.
- On the upper right of the Visual Editor, click the down arrow beside Unlinked. If this item reads Linked instead, Live Sync is already in place for this content. If you need to unlink it but don't have access, contact your team's Admin.
- Choose Request to Push to...[the destination environment].
- In the dialogue that opens, select the Admin that you'd like to make the request of. Notice that the message already has the environment. If you change this message, be sure to keep the environment.
To receive a request to push as an Admin:
- In the content entry, you can optionally open and respond to the comment, if needed, in the Comments tab. For more on comments, see Commenting in Builder.
- Click on the Unlinked dropdown.
- Select the environment to push to.
- In the confirmation dialogue, check that you've chosen the correct environment and, optionally, open a comparison of the content versions to compare the changes.
- Click the Push Now button.
The next video demonstrates this process by showing the request from the user and the Admin's receipt of the request along with pushing.
To request a push as the user with restricted access:
- In the environment from which you would like to push, open the model.
- Click the down arrow beside Unlinked. If this item reads Linked instead, Live Sync is already in place for this model. If you need to unlink it but don't have access, contact your team's Admin.
- Choose Request to Push to...[the destination environment].
- In the dialogue that opens, select the Admin that you'd like to make the request of. Notice that the message already has the environment. If you change this message, be sure to keep the environment.
To receive a request to push as an Admin:
- In the model, click on the Unlinked dropdown.
- Select the environment to push to.
- In the confirmation dialogue, check that you've chosen the correct environment and, optionally, open a comparison of the content versions to compare the changes.
- Click the Push Now button.
The next video demonstrates this process by showing the request from the user and the Admin's push of the model.
