Command line interface for managing Identity Brokerage container

Edit online

CLI is available for managing configuration of Identity Brokerage container. It is possible to configure the Identity Brokerage container to manage users, change the keystore password, update the keystore with a different keystore, manage the certificates in truststore, and change the database password.

Run the utilities by issuing the docker exec command. For Example to run list user utility, run the following command.

docker exec identity-brokerage manageUser listUsers
Note: In case different container name is specified while configuring Identity Agent, then you should use that container name.

Available features

  • manageUser
  • changeKeystorePassword
  • updateKeystore
  • certManagement
  • changeDBPassword

Feature details

manageUser
This utility is provided for the user to add, deactivate, or list the SCIM users. These users are to authenticate REST APIs of Verify.
  • Usage for adding a user is manageUser addUser <username> <password>.
  • Usage for deactivating a user is manageUser deactivateUser <username>.
  • Usage for listing a user is manageUser listUsers.
changeKeystorePassword
This utility is provided for the user to change the current or existing password of the keystore (key.jks) that is in the directory /store/auth. The password is set to “administrator” by default, but later can be changed by the user.
  • Usage for changing a keystore password is: changeKeystorePassword <current_password> <new_password>.
updateKeystore
This utility is provided for users to create and use their own keystore instead of using the default keystore. This keystore contains the Private/Public certificate for Verify.
  • Usage for creating a keystore is updateKeystore <alias> <password>.
changeDBPassword
This utility is provided for users to change the database password from the default password, which is set to ideas. They can change the adminUser password (postgres) or the schemaUser password (itimuser).
  • Usage for changing a database password is changeDBPassword <adminUser/schemaUser> <old_password> <new_password>.
certManagement
This utility is provided to users to use their own certificate in the truststore (trust.jks).
The user must put the certificate in the /store/signercerts directory by running docker copy command,
docker cp <path>/filename identity-brokerage:/store/signercerts
, and then running the certManagement utility.
The user can add a certificate in the truststore, delete a certificate from the truststore, or list all the certificates in the truststore.
  • Usage for adding certificate is certManagement add <fileName> <alias>.
  • Usage for listing the certificates is certManagement list.
  • Usage for deleting an entry from truststore is certManagement delete <alias>.