Create, edit, or unlock a Magento administrator account

First steps

1. Log in to the Magento server as, or switch to, a user with permissions to write to the Magento file system. See switch to the Magento file system owner.

   If you use the bash shell, you can use the following syntax to switch to the Magento file system owner and enter the command at the same time:

   1
   su <Magento file system owner> -s /bin/bash -c <command>
   

   If the Magento file system owner does not allow logins, you can do the following:

   1
   sudo -u <Magento file system owner>  <command>
   

2. To run Magento commands from any directory, add <magento_root>/bin to your system PATH.

   Because shells have differing syntax, consult a reference like unix.stackexchange.com.

   Sample bash shell for CentOS:

   1
   export PATH=$PATH:/var/www/html/magento2/bin
   

   Optionally, you can run the commands in the following ways:

   • cd <magento_root>/bin and run them as ./magento <command name>
   • <magento_root>/bin/magento <command name>
   • <magento_root> is a subdirectory of your web server docroot. Need help locating the docroot?

In addition to the command arguments discussed here, see Common arguments.

Prerequisites

Before you can use this command, you must do all of the following:

• Create the deployment configuration
• Enable at minimum the Magento_Authorization and Magento_User modules
• Create the Magento database schema

The simplest way to create the database is to use the command magento setup:upgrade.

Create or edit an administrator

Use this command to create a new administrator or to edit an existing administrator.

If you’re editing an administrator, only the first name, last name, and password can be edited.

Command usage:

1
bin/magento admin:user:create [--<parameter_name>=<value>, ...]

Where the following table defines parameters and values:

Example of usage:

1
bin/magento admin:user:create --admin-firstname=John --admin-lastname=Doe --admin-email=j.doe@example.com --admin-user=j.doe --admin-password=A0b9%t3g

1
Created Magento administrator user named j.doe

If you do not specify any of required params Magento will ask about them in the CLI:

1
bin/magento admin:user:create

1
2
3
4
5
Admin user: John
Admin password:
Admin email: j.doe.young@example.com
Admin first name: John
Admin last name: Doe Young

1
Created Magento administrator user named John

The following example updates first name, last name, and password of j.doe admin user:

1
bin/magento admin:user:create --admin-firstname="John X" --admin-lastname="Doe X" --admin-email=j.doe@example.com --admin-user=j.doe --admin-password=A1234567

1
Created Magento administrator user named j.doe

Unlock an administrator account

Use this command to unlock the account of an administrator that was locked, typically because of multiple incorrect login attempts.

1
bin/magento admin:user:unlock {username}

You must specify the administrator’s username. Example:

1
bin/magento admin:user:unlock admin

1
The user account "admin" has been unlocked

If the account is either not unlocked or if there was a problem, the following message displays:

1
The user account "admin" was not locked or could not be unlocked

Verify the user is an administrator, the user is active, and that the account is currently locked. To view the list of locked users in the Admin, log in as an administrator and click System > Permissions > Locked Users.

If the account doesn’t exist, the following message displays:

1
Couldn't find the user account "bob"