How To

How do I check what version of AM/OpenAM (All versions) I have installed?

Last updated Sep 15, 2020

The purpose of this article is to provide information on finding the AM/OpenAM product version whether the server is running or not.

Finding the AM/OpenAM version

There are a number of different ways to find the product version. The following sections demonstrate how you can find the version number using different options, with the ones that require a running server noted:

Using the console (running server only)

You can find the version number using the admin console by navigating to any of the following places:

  • Check the footer at the bottom of the AM/OpenAM console. The footer shows the version number once you are logged in as amAdmin (unless you have customized your pages to remove it). For example:

  • Check the value of the property in the console: 
    • AM / OpenAM 13.5: navigate to: Configure > Server Defaults > Advanced
    • OpenAM 13: navigate to: Configuration > Servers and Sites > Default Server Settings > Advanced.
  • Navigate directly to the /json/serverinfo/version endpoint once you are logged into the console as amAdmin, for example:

Using standard Unix and Linux commands

You can use any of the following CLI commands to find the version number:

$ cat /path/to/tomcat/webapps/openam/WEB-INF/classes/ | grep am.version
$ find /path/to/tomcat/webapps/openam -name openam*.jar | grep openam-core

$ cat /path/to/openam/.version 

Example: the following is a hidden .version file located in the /path/to/openam directory:

$ cat /opt/openam/.version 
ForgeRock Access Management 6.5.1 Build 24e379e3e1 (2019-April-05 09:02)

Using REST (running server only)

You can use the REST API to find the version number as follows:

  1. Authenticate as an admin user. For example:
    • AM 5 and later:
      $ curl -X POST -H "X-OpenAM-Username: amadmin" -H "X-OpenAM-Password: cangetinam" -H "Content-Type: application/json" -H "Accept-API-Version: resource=2.1"
    • Pre-AM 5:
      $ curl -X POST -H "X-OpenAM-Username: amadmin" -H "X-OpenAM-Password: cangetinam" -H "Content-Type: application/json"
    Example response:
    { "tokenId": "AQIC5wM2LY4SfcxsuvGEjcsppDSFR8H8DYBSouTtz3m64PI.*AAJTSQACMDIAAlNLABQtNTQwMTU3NzgxODI0NzE3OTIwNAEwNDU2NjE0*", "successUrl": "/openam/console", "realm": "/" } 
  2. Request the server version using the following curl command:
    $ curl -X GET -H "iPlanetDirectoryPro: AQIC5wM2LY4Sfcxs...EwNDU2NjE0*" 
    Example response:
    {"_id":"version","_rev":"-1907117234","version":"6.5.1","fullVersion":"ForgeRock Access Management 6.5.1 Build 24e379e3e1 (2019-April-05 09:02)","revision":"24e379e3e1","date":"2019-April-05 09:02"}

​​​​​​​Using the patchinfo utility

You can use the patchinfo utility to find the version number if you have it installed. See How do I use the patchinfo utility to check what patches are installed for AM/OpenAM (All versions) or IG/OpenIG (All versions)? for further information.

Using ssoadm (running server only)

You can use the following ssoadm command to find the version number, for example:

  • AM 7 and later:
    $ ./ssoadm list-server-cfg -u uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org -f pwd.txt -s default | grep am.version
  • Pre-AM 7:
    $ ./ssoadm list-server-cfg -u amadmin -f pwd.txt -s default | grep am.version

Example response: Access Management 6.5.1 Build 24e379e3e1 (2019-April-05 09:02)

See Also

AM/OpenAM (All versions) upgrade fails when is empty or corrupted

Unable to parse product versions for comparison error after restarting AM/OpenAM (All versions)

Related Training


Related Issue Tracker IDs


Copyright and TrademarksCopyright © 2020 ForgeRock, all rights reserved.