Every Platform.sh user has a role which controls access and improves security on your project. Different roles are authorized to do different things with your applications, environments and users. You can use your collection of Roles to manage how users interact with Platform.sh.
At the project level:
- Project Administrator - A project administrator can change settings and execute actions on any environment.
- Project Reader - A project reader can view all environments within a project but cannot execute any actions on them.
A Project Reader can have a specific role on different environments. At the environment level:
- Environment Administrator - An environment administrator can change settings and execute actions on this environment.
- Environment Contributor - An environment contributor can push code to this environment. He or she can also branch the environment.
- Environment Reader - An environment reader can only view this environment.
Important! After a new user is added to an environment, it needs to be rebuilt. Rebuilds are triggered when you push a new commit to the environment in question. To be able to rebuild without new code changes you can issue the command
git commit --allow-empty -m'rebuild' && git pushto create an empty commit and "force" rebuilding the environment.
When the environment rebuild is complete, allow a minute for the routes to update fully and for the new user to be able to use SSH access.
When a development team works on a project, the team leader can be the
project administrator and decide which roles to give his team members.
One team member can contribute to one environment, another member can
administer a different environment and the customer can be a reader of
If you want your users to be able to see everything (Reader), but only commit to a specific branch, change their permission level on that environment to "Contributor".
Important! An environment contributor can push code to the environment but that user role does not have SSH access to the environment. by default only environment Administrators have SSH access. You can change the default in
.platform.app.yamlby example by specifying
note The project owner - the person licensed to use Platform.sh - doesn't have special powers. A project owner usually has a project administrator role.
Access the project-level configuration.
Click the project configuration icon next to the project name in the upper-left corner of the project page.
Access control tab shows project-level users and their roles.
Selecting a user will allow you either to edit that user's permissions or delete the user's access to the project entirely.
Add a new user by clicking on the
Add user button.
If you select the 'Reader' role for the user, you'll have the option of adjusting the user's permissions at the environment level.
Once this has been done, if the user does not have a Platform.sh account, they will receive an email asking to confirm their details and register an account name and a password.
In order to push and pull code (or to SSH to one of the project's environments) the user will need to add an SSH key.
If the user already has an account, they will receive an email with a link to the project.
Access the environment-level configuration.
Click the environment configuration icon next to the environment name on the project page.
User Management tab shows environment-level users and their
Selecting a user will allow you either to edit that user's permissions or delete the user's access to the environment entirely.
Add a new user by clicking on the
Add user button.
note Remember the user will only be able to access the environment once it has been rebuilt (after a
You can user the Platform.sh command line client to fully manage your users and integrate this with any other automated system.
- Add a user to the project
- Delete a user
- user:list (users)
- List project users
- View or change a user's role
For example, the following command would add the 'admin' role to email@example.com in the current project.
This will present you with an interactive wizard that will allow you to choose precisely what rights you want to give the new user.
$ platform user:add Email address: firstname.lastname@example.org The user's project role can be 'viewer' ('v') or 'admin' ('a'). Project role [V/a]: The user's environment-level roles can be 'viewer', 'contributor', or 'admin'. development environment role [V/c/a]: sprint1 environment role [V/c/a]: hot-fix environment role [V/c/a]: master environment role [V/c/a]: pr-2 environment role [V/c/a]: pr-3 environment role [V/c/a]: Summary: Email address: email@example.com Project role: viewer development: viewer sprint1: viewer hot-fix: viewer pr-2: viewer pr-3: viewer Adding users can result in additional charges. Are you sure you want to add this user? [Y/n] User firstname.lastname@example.org created
Once this has been done, the user will receive an email asking her to confirm her details and register an account name and a password.
To give Alice the 'contributor' role on the environment 'development', you could run:
platform user:role email@example.com --level environment --environment development --role contributor
platform list to get the full list of commands.
If you want to transfer ownership of a project to a different user, first invite that user as a project administrator and then submit a support ticket from the current project owner to ask for the transfer.
This action will automatically transfer the subscription charges to the new owner.