This reference covers OpenAM tools, log formats, error codes, file layout, ports used, standards supported, locales supported, and configuration file semantics.

This references is written for access management designers, developers, and administrators using OpenAM tools, logs, and configuration files. For API specifications, see the appropriate Javadoc.

This work is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. See the license for the specific language governing permissions and limitations under the license.

Pay attention to notes like this one. Some items might be formatted differently from other text, like filenames, commands, and literal values. $ echo Terminal sessions are formatted like this. Terminal sessions are formatted like this. class Test { public static void main(String [] args) { System.out.println("This is a program listing."); } } In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD, and so forth are marked (UNIX). Sections pertaining to Microsoft Windows might be marked (Windows). To avoid repetition, however, file system directory names are often given only in UNIX format as in /path/to/OpenAM, even if the text applies to C:\path\to\OpenAM as well. Ignore warnings at your own risk.

Core documentation, such as what you are now reading, aims to be technically accurate and complete with respect to the software documented. Core documentation therefore follows a three-phase review process designed to eliminate errors. The review process should slow authors down enough that documentation you get with a stable release has had time to bake fully. Fully baked core documentation is available at .... You need not wait until the core documentation is finished, though, to read more about OpenAM, and also to read about related topics that involve OpenAM without being strictly about OpenAM. The OpenAM Wiki regularly brings you more, fresh content. In addition, you are welcome to sign up and then edit the Wiki if you notice an error, or if you have something to share.

After you sign up at ForgeRock, you can also login to the Wiki and the issue database to follow what is happening with the project. If you have questions regarding OpenAM which are not answered by the documentation, there is a mailing list which can be found at https://lists.forgerock.org/mailman/listinfo/openam where you are likely to find an answer. The Wiki has information on how to check out OpenAM source code. There is also a mailing list for OpenAM development which can be found at https://lists.forgerock.org/mailman/listinfo/openam-dev Should you want to contribute a patch, test, or feature, or want to author part of the core documentation, first have a look on the ForgeRock site at how to get involved.