Send Docs Feedback

Resetting Edge Passwords

Edge for Private Cloud v. 4.16.09

You can reset the OpenLDAP, Apigee Edge system administrator, Edge organization user, and Cassandra passwords after the installation is complete.

Reset OpenLDAP Password

Depending on your Edge configuration, OpenLDAP can be installed as:

  • A single instance of OpenLDAP installed on the Management Server node. For example, in a 2-node, 5-node, or 9-node Edge configuration.
  • Multiple OpenLDAP instances installed on Management Server nodes, configured with OpenLDAP replication. For example, in a 12-node Edge configuration.
  • Multiple OpenLDAP instances installed on their own nodes, configured with OpenLDAP replication. For example, in a 13-node Edge configuration.

The way you reset the OpenLDAP password depends on your configuration.

If you have lost the existing OpenLDAP password, you can still reset it. See OpenLDAP Maintenance Tasks for more.

For a single instance of OpenLDAP installed on the Management Server, perform the following:

  1. On the Management Server node, run the following command to create the new OpenLDAP password:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-openldap change-ldap-password -o oldPword -n newPword
  2. Run the following command to store the new password for access by the Management Server:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-management-server store_ldap_credentials -p newPword

    This command restarts the Management Server.

In an OpenLDAP replication setup with OpenLDAP installed on Management Server nodes, follow the above steps on both Management Server nodes to update the password.

You must set identical new password on both LDAP servers in order to achieve successful OpenLDAP replication.

In an OpenLDAP replication setup with OpenLDAP being on a node other than Management Server, ensure that you first change the password on both OpenLDAP nodes, then on both Management Server nodes. 

Reset System Admin Password

Resetting the system admin password requires you to reset the password in two places:

  • Management Server
  • UI

You cannot reset the system admin password from the Edge UI. You must use the procedure below to reset it.

Warning: You should stop the Edge UI before resetting the system admin password. Because you reset the password first on the Management Server, there can be a short period of time when the UI is still using the old password. If the UI makes more than three calls using the old password, the OpenLDAP server locks out the system admin account for three minutes.

If you have lost the existing Edge system admin password, you can still reset it. See OpenLDAP Maintenance Tasks for more.

To reset the system admin password: 

  1. On the UI node, stop the Edge UI:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-ui stop
  2. On the Management Server, run the following command to reset the password:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-management-server change_sysadmin_password -o currentPW -n newPW
  3. Edit the silent config file that you used to install the Edge UI to set the following properties:

    Note that you have to include the SMTP properties when passing the new password because all properties on the UI are reset.
  4. Use the apigee-setup utility to reset the password on the Edge UI from the config file:
    > /<inst_root>/apigee/apigee-setup/bin/ -p ui -f configFile
  5. Start the Edge UI on the UI node:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-ui start
  6. (Only if TLS is enabled on the UI) Re-enable TLS on the Edge UI as described in Configuring TLS for the management UI.

In an OpenLDAP replication environment with multiple Management Servers, resetting the password on one Management Server updates the other Management Server automatically. However, you have to update all Edge UI nodes separately.

Reset Organization User Password

To reset the password for an organization user, use the apigee-servce utility to invoke apigee-setup:

/<inst_root>/apigee/apigee-service/bin/apigee-service apigee-setup reset_user_password
 [-p USER_PWD]
 [-f configFile]

For example:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-setup reset_user_password -u -p foo12345 -a -P adminPword 

If you omit the admin email, then it uses the default admin email set at installation time. If you omit the admin password, then the script prompts for it. All other parameters must be set on the command line, or in a config file. 

Shown below is an example config file that you can use with the "-f" option:

USER_PWD= "foo12345"

You can also use the Update user API to change the user password. 

Sys Admin and Organization User Password Rules

Use this section to enforce a desired level of password length and strength for your API management users. The settings use a series of preconfigured (and uniquely numbered) regular expressions to check password content (such as uppercase, lowercase, numbers, and special characters).  Write these settings to /<inst_root>/apigee/customer/application/ file. If that file does not exist, create it.

After editing, restart the management server:

> /<inst_root>/apigee/apigee-service/bin/apigee-service edge-management-server restart

You can then set password strength ratings by grouping different combinations of regular expressions. For example, you can determine that a password with at least one uppercase and one lowercase letter gets a strength rating of "3", but that a password with at least one lowercase letter and one number gets a stronger rating of "4".

By default, the Edge UI auto generates passwords that are compatible with the default password rules defined on the Edge Management Server. If you change these rules, you should also update the Edge UI so that it auto generates user passwords appropriately. See Configure rules used to auto generate Edge UI passwords for more.








Use these to determine the overall characteristics of valid passwords. The default minimum rating for password strength (described later in the table) is 3.

Notice that the password.validation.default.rating=2 is lower than the minimum rating required, which means that if a password entered falls outside of the rules you configure, the password is rated a 2 and is therefore invalid (below the minimum rating of 3).

Following are regular expressions that identify password characteristics. Note that each one is numbered. For example, "password.validation.regex.5=…" is expression number 5. You’ll use these numbers in a later section of the file to set different combinations that determine overall password strength.


1 – All characters repeat


2 – At least one lowercase letter


3 – At least one uppercase letter


4 – At least one digit


5 – At least one special character (not including underscore _)


6 – At least one underscore


7 – More than one lowercase letter


8 – More than one uppercase letter


9 – More than one digit


10 – More than one special character (not including underscore)


11 – More than one underscore

The following rules determine password strength based on password content. Each rule includes one or more regular expressions from the previous section and assigns a numeric strength to it. The numeric strength of a password is compared to the conf_security_password.validation.minimum.rating.required number at the top of this file to determine whether or not a password is valid.









Each rule is numbered. For example, "password.validation.rule.3=…" is rule number 3.

Each rule uses the following format (right of the equals sign):


regex-index-list is the list of regular expressions (by number from the previous section), along with an AND|OR operator (meaning, consider all or any of the expressions listed).

rating is the numeric strength rating given to each rule.

For example, rule 5 means that any password with at least one special character OR one underscore gets a strength rating of 4. With password.validation.minimum.
rating.required=3 at the top of the file, a password with a 4 rating is valid.


Set role-based access control password validation to false when single sign-on (SSO) is enabled. Default is true.

Resetting Cassandra password

By default, Cassandra ships with authentication disabled. If you enable authentication, it uses a predefined user named 'cassandra' with a password of 'cassandra'.  You can use this account, set a different password for this account, or create a new Cassandra user. Add, remove, and modify users by using the Cassandra CREATE/ALTER/DROP USER statements. 

For information on how to enable Cassandra authentication, see Enable Cassandra authentication .

To reset the Cassandra password, you have to:

  • Set the password on any one Cassandra node and it will be broadcast to all Cassandra nodes in the ring
  • Update the Management Server, Message Processors, Routers, Qpid servers, Postgres servers, and BaaS Stack on each node with the new password

For more information, see

To reset the Cassandra password:

  1. Log into any one Cassandra node using the cqlsh tool and the default credentials. ​You only have to change the password on one Cassandra node and it will be broadcast to all Cassandra nodes in the ring:
    > /<inst_root>/apigee/apigee-cassandra/bin/cqlsh cassIP 9042 -u cassandra -p cassandra

    • cassIP is the IP address of the Cassandra node.
    • 9042 is the Cassandra port. 
    • The default user is cassandra
    • The default password is cassandra. If you changed the password previously, use the current password.
  2. Run the following command as the cqlsh> prompt to update the password: 

    If the new password contains a single quote character, escape it by preceding it with a single quote character.
  3. Exit the cqlsh tool:
    cqlsh> exit
  4. On the Management Server node, run the following command:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-management-server store_cassandra_credentials -u CASS_USERNAME -p CASS_PASSWORD 

    Optionally, you can pass a file to the command containing the new username and password:
    > apigee-service edge-management-server store_cassandra_credentials -f configFile 

    Where the configFile contains the following:

    This command automatically restarts the Management Server.
  5. Repeat step 4 on:
    • All Message Processors 
    • All Routers
    • All Qpid servers (edge-qpid-server)
    • Postgres servers  (edge-postgres-server)
  6. On the BaaS Stack node for version and later:
    1. Run the following command to generate an encrypted password:
      > /opt/apigee/apigee-service/bin/apigee-service baas-usergrid secure_password

      This command prompts you for the plain text password and returns the encrypted password in the form:
    2. Set the following tokens in /opt/apigee/customer/application/ If that file does not exist, create it:

      This example uses the default username for Cassandra. If you changed the username, set the value of usergrid-deployment_cassandra.username accordingly.

      Ensure that you include the "SECURE:" prefix on the password. Otherwise, the BaaS Stack interprets the value as unencrypted.

      Note: Each BaaS Stack node has its own unique key used to encrypt the password. Therefore, you must generate the encrypted value on each BaaS Stack node separetly.
    3. Change ownership of the file to the 'apigee' user:
      > chown apigee:apigee /opt/apigee/customer/application/
    4. Configure the Stack node:
      > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid configure
    5. Restart the BaaS Stack:
      > /<inst_root>/apigee/apigee-service/bin/apigee-service baas-usergrid restart
    6. Repeat these steps for all BaaS Stack nods. 

 The Cassandra password is now changed. 

Resetting PostgreSQL password

By default, the PostgreSQL database has two users defined: 'postgres' and 'apigee'. Both users have a default password of 'postgres'. Use the following procedure to change the default password. 

Change the password on all Postgres master nodes. If you have two Postgres servers configured in master/standby mode, then you only have to change the Password on the master node.  See Set up Master-Standby Replication for Postgres for more.

After you change the 'apigee' and 'postgres' user passwords in steps 2 and 3 below, no data is written to the PostgreSQL database until you complete all the other steps.

As part of the steps below, you set the password for both the 'postgres' and 'apigee' PostgreSQL users. While this example sets them both to the same value, that is not required.

  1. On the Master Postgres node, change directory to /<inst_root>/apigee/apigee-postgresql/pgsql/bin, where /<inst_root> defaults to /opt.
  2. Set the PostgreSQL 'postgres' user password:
    1. Login to PostgreSQL database using the command: 
      > psql -h localhost -d apigee -U postgres
    2. When prompted, enter the 'postgres' user password as 'postgres'.
    3. At the PostgreSQL command prompt, enter the following command to change the default password:
      apigee=> ALTER USER postgres WITH PASSWORD 'apigee1234';
    4. Exit PostgreSQL database using the command:
      apigee=> \q
  3. Set the PostgreSQL 'apigee' user password:
    1. Login to PostgreSQL database using the command: 
      > psql -h localhost -d apigee -U apigee
    2. When prompted, enter the 'apigee' user password as 'postgres'.
    3. At the PostgreSQL command prompt, enter the following command to change the default password:
      apigee=> ALTER USER apigee WITH PASSWORD 'apigee1234';
    4. Exit PostgreSQL database using the command:
      apigee=> \q
    > export APIGEE_HOME=/<inst_root>/apigee/edge-postgres-server
  5. Encrypt the new password: 
    > sh /<inst_root>/apigee/edge-postgres-server/utils/scripts/utilities/ apigee1234

    This command returns the encrypted password as shown below. The encrypted password starts after the ":" character and does not include the ":".
    Encrypted string :WheaR8U4OeMEM11erxA3Cw==
  6. Update the Management Server node with the new encrypted passwords for the 'postgres' and 'apigee' users.
    1. On the Management Server, change directory to /<inst_root>/apigee/customer/application.
    2. Edit the file to set the following properties. If this file does not exist, create it: 
      Note: Some properties take the encrypted 'postgres' user password, and some take the encrypted 'apigee' user password.
      • conf_pg-agent_password=newEncryptedPasswordForPostgresUser
      • conf_pg-ingest_password=newEncryptedPasswordForPostgresUser
      • conf_query-service_pgDefaultPwd=newEncryptedPasswordForApigeeUser
      • conf_query-service_dwDefaultPwd=newEncryptedPasswordForApigeeUser
    3. Make sure the file is owned by 'apigee' user:
      > chown apigee:apigee
  7. Update all Postgres Server and Qpid Server nodes with the new encrypted password.
    1. On the Postgres Server or Qpid Server node, change directory to /<inst_root>/apigee/customer/application.
    2. Edit the following files. If these files do not exist, create them:
    3. Add the following properties to the files:
      Note: All of these properties take the encrypted 'postgres' user password.
      • conf_pg-agent_password=newEncryptedPasswordForPostgresUser
      • conf_pg-ingest_password=newEncryptedPasswordForPostgresUser
      • conf_query-service_pgDefaultPwd=newEncryptedPasswordForPostgresUser
      • conf_query-service_dwDefaultPwd=newEncryptedPasswordForPostgresUser
    4. Make sure the files are owned by 'apigee' user:
      > chown apigee:apigee
      > chown apigee:apigee
  8. Restart the following components in this order:
    1. PostgreSQL database:
      > /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-postgresql restart
    2. Qpid Server:
      > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-qpid-server restart
    3. Postgres Server: 
      > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-postgres-server restart
    4. Management Server:
      > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-management-server restart

Help or comments?