Research Academy Daily Swig
My account Customers About Blog Careers Legal Contact Resellers

ENTERPRISE

Creating an admin user via the CLI

  • Last updated: May 17, 2022

  • Read time: 2 Minutes

If you have a SCIM user or API user with the name administrator, you will not be able to reset a forgotten or lost admin password using the normal resetAdminPassword script. Instead, you need to use the adminusercreator. This requires more manual input, but allows you to create a new admin user with a custom name.

Standard deployments

  1. From a command prompt, execute the adminusercreator script found in your installation directory, providing the required parameters. For example:

    /<your-installation-directory>/adminusercreator --username=new_admin --password=letmein --email=admin@example.com --dbUrl="jdbc:<your-database-url>" --dbUsername=burp_enterprise --dbPassword=securepassword
  2. Log in to Burp Suite Enterprise Edition as normal with the username and password you just set.

Kubernetes deployments

  1. Connect to your Burp Suite Enterprise Edition Kubernetes cluster.

  2. Run the following command to output the details of your Burp Suite Enterprise Edition pods:

    kubectl -n bsee get pods

  3. In the output, find the name of the Enterprise server pod. This should begin with bsee-enterprise-server-deployment- followed by a unique identifier.

  4. Run the following command to execute the script, providing the required parameters. For example:

    kubectl -n bsee exec <your-Enterprise-server-pod-name> ./bin/adminusercreator --username=new_admin --password=letmein --email=admin@example.com --dbUrl="jdbc:<your-database-url>" --dbUsername=burp_enterprise --dbPassword=securepassword

  5. Log in to Burp Suite Enterprise Edition as normal with the username and password you just set.

Required parameters

The following parameters are all mandatory when running the adminusercreator script.

Parameter

Description

--username

The username you want to set for the new user. Note that this cannot be the same as an existing user.

--password

The initial password that you want to set for the new user.

--email

The email address that you want to set for the new user.

--dbUrl

The connection (JDBC) URL for your database.

If you've forgotten this, you can retrieve it from the Enterprise server's configuration file. Go to /<installation-directory>/enterpriseServer/<version-number>/enterprise-server.config and copy the admin_repository.url property.

--dbUsername

The database username for the Enterprise server.

You can also retrieve this from the enterprise-server.config file under admin_repository.username.

--dbPassword

The database password for the Enterprise server user.

You can also retrieve this from the enterprise-server.config file under admin_repository.password.