User administration

Last updated 24th June 2022

Objective

Learn about user roles and environment types, how to add and delete users, and how to assign user permissions per environment type.

Instructions

User roles

Within a project, each user has a role that controls their access and permission levels.

  • Project Admin: Users who can configure project settings, add and remove users, administer environment permissions, push code, and execute actions on all project environments.
  • Project Viewer: Any user with access to environment types automatically gets this role.

These control who has access to projects.

Users can still see projects that they can't access if they're a member of an organization. See more on access control for organizations.

To see all projects you have a role in, from the main console page click All projects > All projects.

Environment types

Each environment type groups one or more environments together so that you can manage access for all environments of a certain type. This allows you to set permissions for multiple environments at once based on their purpose.

Web PaaS offers three environment types: Production, Staging, and Development. You can assign user permissions for each environment type. Any permissions you assign to an environment type apply to all environments of that type.

For example, if you assign User1 Admin permissions for Development environments, User1 has Admin permissions for all environments of that type.

A few things to consider:

  • Only one environment per project can be the Production type. It's set automatically as the default branch and can't be overridden separately.
  • You can change an environment's type (if it's not Production).
  • You can have multiple Staging and Development environments.

The following table shows the available roles for environment types.

Role View environment Push code Branch environment SSH access Change settings Execute actions
Viewer Yes No No No No No
Contributor Yes Yes Yes Yes No No
Admin Yes Yes Yes Yes Yes Yes

To customize who can use SSH, set the access key in your platform.app.yaml file.

Manage users

Add a user to a project

To add a user, you need to be a Project Admin.

To add a user to a project or an environment, follow these steps:

<!--This is in HTML to get the icon not to break the list. -->
<ol>
  <li>Select the project where you want to add a new user.</li>
  <li>Click <strong>Settings</strong>.</li>
  <li>Click <strong>Access</strong>.</li>
  <li>Click <strong>+ Add</strong>.</li>
  <li>Add the user's details and choose their permissions.</li>
  <li>Click <strong>Save</strong>.</li>
</ol>
Say you want to add `user1@example.com` to the project with a Project Admin role:

```bash
webpaas user:add user1@example.com -r admin

```

The user has to create an account before they can contribute to the project. Once you add a user to a project, they receive an email with instructions. For SSH access changes to apply after you add a user to a project, you have to redeploy each environment by either clicking Redeploy in the console or running webpaas redeploy.

Delete a user from a project

To delete a user, you need to be a Project Admin.

To delete a user from a project, follow these steps:

<!--This is in HTML to get the icon not to break the list. -->
<ol>
  <li>Select the project where you want to add a new user.</li>
  <li>Click <strong>Settings</strong>.</li>
  <li>Click <strong>Access</strong>.</li>
  <li>Expand the user you want to delete.</li>
  <li>Click <strong>Delete</strong>.</li>
  <li>Click <strong>Save</strong>.</li>
</ol>
To delete existing users:

```bash
webpaas user:delete user1@example.com

```

Once you delete a user, they can no longer access the project. After you delete a user from a project or an environment type, you must trigger a redeploy to propagate SSH access changes to each environment.

Change existing permissions for environment types

To manage user permissions, you need to be a Project Admin.

To change user permissions, follow these steps:

<!--This is in HTML to get the icon not to break the list. -->
<ol>
  <li>Select the project where you want to add a new user.</li>
  <li>Click <strong>Settings</strong>.</li>
  <li>Click <strong>Access</strong>.</li>
  <li>Expand the user you want to delete.</li>
  <li>Click <strong>Delete</strong>.</li>
  <li>Click <strong>Delete</strong> to confirm.</li>
</ol>
Say you want `user1@example.com` to have the Viewer role for Production environments
and the Contributor role for Development environments:

```bash
webpaas user:update user1@example.com -r production:v,development:c

After you change a user's role for an environment type, you must trigger a redeploy each environment to propagate access changes. You can redeploy using the CLI command webpaas redeploy.

```


Did you find this guide useful?

Please feel free to give any suggestions in order to improve this documentation.

Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.

Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.

Thank you. Your feedback has been received.


These guides might also interest you...

OVHcloud Community

Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.

Discuss with the OVHcloud community

In accordance with the 2006/112/CE Directive, modified on 01/01/2015, prices exclude VAT. VAT may vary according to the customer's country of residence.