ÃÛ¶¹ÊÓƵ

DocumentationCommerceCommerce on Cloud Infrastructure Guide

Manage user access

Last update: Thu Sep 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Admin

ÃÛ¶¹ÊÓƵ Commerce projects on cloud infrastructure use role-based access. There are two roles available at the project level:

  • Project admin—Write access to all project environments and can manage users, push code, and update project settings. (Previously known as Super admin)
  • Project viewer—View-only access to all project environments.

Project viewers cannot perform tasks on any environment; however, you can grant project viewers write access to a specific environment type.

Environment-level access is based on the environment type: production, staging, and development. Granting a user viewer permission to development environments means that they can view all development environments in the project. The following table clarifies the abilities granted to each permission level:

Permission level
Access
SSH access
Admin
Perform administrator tasks, such as change settings, push code, perform tasks, and branch management, including merging with the parent environment
Yes
Contributor
Push code and branch the environment; cannot change settings or execute actions
Yes
Viewer
View-only access to the environment type
No
No access
No access to the environment type
No

You can add users and assign roles using the magento-cloud CLI or the Cloud Console.

recommendation-more-help

Prerequisites:

  • A registered user with an ÃÛ¶¹ÊÓƵ ID. A user must and then before you can add them to a Cloud project.
  • A user assigned the Admin role cannot manage users with the magento-cloud CLI. Only users that are granted the Account Owner role can manage users.
style
shade-box

Manage users with the CLI

Use the magento-cloud CLI to manage users and integrate with automated systems:

  • magento-cloud user:add–add a user to the project
  • magento-cloud user:delete–delete a user
  • magento-cloud user:list [users]–list project users
  • magento-cloud user:role–view or change the user role
  • magento-cloud user:update–update user role on a project

The following examples use the magento-cloud CLI to add a user, configure roles, modify project assignments, and assign user roles.

To add a user and assign roles:

  1. Use the magento-cloud CLI to add the user.

    code language-bash 
    magento-cloud user:add
    note important
    IMPORTANT
    The user must have an ÃÛ¶¹ÊÓƵ ID; see the prerequisites.

  2. Follow the prompts: specify the user email address, set the project and environment-type roles, and add the user.

    Sample prompts

    code language-none 
    Enter the user's email address: alice@example.com

Email address: alice@example.com

The user's project role can be admin (a) or viewer (v).

Project role (default: viewer) [a/v]: viewer

The user's environment type role(s) can be admin (a), viewer (v), contributor (c) or none (n).

Role on type development (default: none) [a/v/c/n]: none
Role on type production (default: none) [a/v/c/n]: admin
Role on type staging (default: none) [a/v/c/n]: admin

Adding the user alice@example.com to (project_id):
Project role: viewer
  Role on type production: admin
  Role on type staging: admin

Are you sure you want to add this user? [Y/n] y
Adding the user to the project

    After you add the user, ÃÛ¶¹ÊÓƵ sends an email to the specified address with instructions for accessing the ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project.

View a user’s project role

magento-cloud user:get alice@example.com

Sample response:

Current role(s) of User (alice@example.com) on Production (project_id):
  Project role: admin

Add a user to multiple environments

To add a user as a viewer on a Production environment, and as a contributor on an Integration environment:

magento-cloud user:add alice@example.com -r production:v -r integration:c

Update user environment permissions

To update user environment permissions to admin on the Production environment:

magento-cloud user:update alice@example.com -r production:a

Manage users from the Cloud Console

You can use the Cloud Console to add permissions and use the Edit feature to modify permissions for an existing user.

IMPORTANT
The user must have an ÃÛ¶¹ÊÓƵ ID; see the prerequisites.

Add a user to the project

  1. Log in to the .

  2. Select a project from the All projects list.

  3. On the Project dashboard, click the configuration icon in the upper right.

  4. Under Project Settings, click Access.

  5. In the Access view, click Add.

  6. Complete the Add User form:

    • Enter the user email address.

    • Project admin—grant Admin rights to all settings and environment types.

    • Environment types and permissions—grant access and specific permission levels to certain environment types. No access, Admin (change settings, execute action, merge code), Contributor (push code), or Viewer (view only).

    note tip
    TIP
    Only a Project admin can manage users in any environment. To grant a user access to the Access tab, another Project admin or the Account Owner must assign that user the Project admin role.

  7. Click Add User.

    note important
    IMPORTANT
    Adding a user does not trigger a deployment automatically.

  8. After adding users, redeploy all environments to apply the changes. Adding a user does not trigger a deployment automatically. Redeployment is an important step to ensure that the user can access an environment using SSH or perform administrator tasks.

After you add the user, ÃÛ¶¹ÊÓƵ sends an email to the specified address with instructions for accessing the ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project.

User authentication requirements

For added security, ÃÛ¶¹ÊÓƵ provides project-level multi-factor authentication (MFA) enforcement to require two-factor authentication (TFA) for SSH access to ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project source code and environments. See Enable MFA for SSH.

When MFA enforcement is enabled on an ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project, all users with SSH access to an environment in that project must enable TFA on their ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure account. For automated processes, you can create a machine user and API token to authenticate from the command line.

After you add a user to a Cloud project, ask the user to review their account security settings and add the following security configurations as needed:

  • Enable TFA—Meet security and compliance standards by configuring two-factor authentication. Projects configured with MFA enforcement require TFA on accounts that use SSH to access the projects.

  • Enable SSH keys—Users that require access to ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure source code repositories must enable SSH keys on their account. See Secure connections.

  • Create an API token—Users must generate an API token that is used for SSH access to an environment. You need the token to enable authentication workflows for automated processes.

    On projects with MFA enforcement enabled, you must use the API token to authenticate SSH access requests from automated accounts. The token allows automated processes to bypass authentication workflows which require TFA.

Enable TFA for Cloud accounts

ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure supports TFA using any of the following applications:

Instructions for installing the authenticator application and enabling TFA are available on the Account settings page in the Cloud Console.

To enable TFA on your user account:

  1. Log in to .

  2. In the upper-right account menu, click My Profile.

  3. On the Security tab, click Set up application.

  4. If you do not have an approved authenticator application on your mobile device, use the linked instructions to install one.

  5. Add your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure account to the authenticator application.

    • On your mobile device, open the authenticator application. Then, add the setup code to the application.

    • In the TFA set up - Application page, type the TFA code from your mobile device in the Application verification code field.

    • Click Verify and save.

      If the code is valid, ÃÛ¶¹ÊÓƵ sends a notification to the account email address confirming that the account now has TFA.

  6. Optional. Enable Trusted browser settings to cache the authentication code in the browser for 30 days.

    This configuration reduces the number of authentication challenges during project login.

  7. Click Save or Skip.

  8. Save the recovery codes.

    • On the TFA setup - Recovery codes page, copy and save the recovery codes so that you can log into your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project when you cannot access your mobile device or authentication application.

    • Copy the recovery codes to another location or write them down in case you lose access to your device or authentication application.

    • Click Save to save the codes to your account so you can view and manage them from your account security settings.

      note warning
      WARNING
      If you lose access to an account with TFA and do not have the recovery codes list, you must contact your project administrator, or Submit an ÃÛ¶¹ÊÓƵ Commerce Support ticket to reset the TFA application.

  9. After completing the TFA setup, click Save to update your account.

  10. Authenticate your current session with TFA.

    • Log out of your account.
    • Log in with your username and password.
    • When prompted, enter the TFA code for the accounts.magento.cloud entry from the authenticator application on your mobile device.

Manage TFA configuration and recovery codes

You can manage the TFA configuration for an ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure account from the Security section on the My Profile page.

  1. Log in to .

  2. In the upper-right account menu, click My Profile.

  3. On the My Profile page, click the Security tab.

  4. Use the available links to update the TFA settings for your ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure account:

    • Disable TFA
    • Reset the authenticator application
    • Add or remove trusted browsers
    • View or refresh TFA recovery codes on your account

Create an API token

An API token can be exchanged for an OAuth 2 access token, which can then be used to authenticate requests.

On projects that have MFA enforcement enabled, you must have an API token to enable SSH access for machine users and automated processes.

IMPORTANT
Protect API token values for your account. Do not expose the value in code samples, screen captures, or insecure client-server communications. Also, do not expose the value in source code stored in public repositories.

To create an API token:

  1. Log in to .

  2. In the upper-right account menu, click My Profile.

  3. On the My Profile page, click the API tokens tab.

  4. Click Create API token and enter a name, for example, specify a name that matches the machine user or automated process that uses the API token.

    API tokens

  5. Click Create API token.

05f2f56e-ac5d-4931-8cdb-764e60e16f26