Child pages
  • If you're new to OpenAM
Skip to end of metadata
Go to start of metadata

If you're new to OpenAM and have done a little searching, you may be overwhelmed by the available information. The purpose of this documents is to suggest a few basic steps if you're new to OpenAM and want to get up to speed.

“As noted on, ‘OpenAM is the world's only all-in-one access management platform with the adaptive intelligence to protect against risk-based threats across any environment.’”
If you’re new to OpenAM, ForgeRock provides an introduction to this (and the other parts of the ForgeRock identity stack in a white paper, available from ).

Downloads of the OpenAM Enterprise product are available from a download page on Downloads of the current OpenAM product in development is available from a "Nightly Build" webpage on

Just be aware, the standard ForgeRock license associated with either download is limited to “developing, testing, prototyping and/or demonstrating your application”. For more information, see . If you want to do more, please review information on subscriptions at .

Once your download is complete, there is a dedicated installation guide available for both the official Enterprise and Xpress releases, as well as the nightly build. You can download the documentation for the official releases from You can download the "in progress" documentation for the nightly build from the OpenAM documentation page.
You should also know that OpenAM requires the installation of a servlet container such as Tomcat, JBoss, or Glassfish. While a web server such as Apache or IIS is helpful and commonly used on production systems, a web server is not required to install or run OpenAM.
If you want to test features associated with OpenAM, much of it is already described in the published Administrative Guide, available from the same URLs where you can download the Installation Guide. As noted in the Administrative Guide preface:
“This guide shows you how to configure, maintain, and troubleshoot OpenAM for single sign on and authorization, password reset, account lockout, cross-domain single sign on, and federation.” 
Once you have OpenAM operational on the system of your choice, you can start the learning process. The developers among you may be interested in the Developers Guide, available from the same URLs:
“This guide demonstrates how to handle sessions to permit single sign on and single log out in OpenAM client applications. This guide further demonstrates how to use the OpenAM APIs including both APIs for client applications, and also SPIs for authentication, policy, service management, delegation, and identity storage. Finally, this guide demonstrates how to write your own web policy agent.” 
If you have problems, we encourage you to ask your question on our mailing list. As noted in our documentation:
“If you have questions regarding OpenAM which are not answered by the documentation, please feel free to review the OpenAM mailing list. If the question hasn't already been answered there, sign up and ask your question. You can also make suggestions regarding updates at the documentation mailing list.” Subscription instructions are available at both of these URLs.
If you still have problems, you may wish to file a bug report. The process for filing a bug is described here You’ll need a community account, which you can create here. You can then follow the instructions here: How should I file a bug.
While much of the documentation on this wiki is excellent, we depend on you to help keep it up to date. See the options at for adding content and editing. 

  • No labels