Notes covering new features, fixes and known issues in the ForgeRock Service Broker.


Read these release notes before you install ForgeRock Service Broker or update your existing ForgeRock Service Broker Installation.

The information contained in these release notes cover prerequisites for installation, known issues and improvements to the software, changes and deprecated functionality, and other important information.

About ForgeRock Identity Platform™ Software

ForgeRock Identity Platform™ is the only offering for access management, identity management, user-managed access, directory services, and an identity gateway, designed and built as a single, unified platform.

The platform includes the following components that extend what is available in open source projects to provide fully featured, enterprise-ready software:

  • ForgeRock Access Management (AM)

  • ForgeRock Identity Management (IDM)

  • ForgeRock Directory Services (DS)

  • ForgeRock Identity Gateway (IG)

  • ForgeRock Identity Message Broker (IMB)

Chapter 1. What's New in This release

This chapter covers the new features, improvements, and fixes in the ForgeRock Service Broker.

1.1. New Features

The ForgeRock Service Broker 2.0.1 now provides an IG Route Service in addition to the to AM OAuth 2.0 Service.

The IG Route Service can be used to filter traffic to and from Cloud Foundry applications, adapting requests to protect applications, and adapting responses to filter outgoing content.

1.2. Security Advisories

ForgeRock issues security advisories in collaboration with our customers and the open source community to address any security vulnerabilities transparently and rapidly. ForgeRock's security advisory policy governs the process on how security issues are submitted, received, and evaluated as well as the timeline for the issuance of security advisories and patches.

For more information on ForgeRock's security advisory policy, click the following link:

Chapter 2. Prerequisites

This chapter covers prerequisites for installing and running the ForgeRock Service Broker.

ForgeRock supports customers using the versions specified here. Other versions and alternative environments might work as well. When opening a support ticket for an issue, however, make sure you can also reproduce the problem on a combination covered here.

2.1. Version Requirements

The ForgeRock Service Broker supports the following external ForgeRock product versions:

  • OpenAM 13 or OpenAM 13.5

  • AM 5 or later

  • IG 5 or later

2.2. Special Requests

If you have a special request regarding support for a combination not listed here, contact ForgeRock at

Chapter 3. Changes and Deprecated Functionality

This chapter covers both major changes to existing functionality, and also deprecated and removed functionality.

3.1. Important Changes to Existing Functionality

The AM OAuth 2.0 Service is now called forgerock-am-oauth2. In the previous release, it was called openam-oath2.

3.2. Deprecated Functionality

No existing functionality has been deprecated in this release.

3.3. Removed Functionality

No existing functionality has been removed in this release.

Chapter 4. Limitations and Known Issues

ForgeRock Service Broker issues are tracked at This chapter covers the status of key issues and limitations at release 2.

4.1. Limitations

No limitations are attributed to this release.

4.2. Known Issues

No important known issues are attributed to this release.

Chapter 5. Documentation Updates

The following table tracks changes to the documentation set following the release of ForgeRock Service Broker 2:

Table 5.1. Documentation Change Log

Release 2. Change to the version number of the download file for ForgeRock Identity Platform for PCF.


Release 2. A chapter for the IG Route Service has been added to this release.


Initial release.

Appendix A. Getting Support

For more information or resources about OpenAM and ForgeRock Support, see the following sections:

A.1. Accessing Documentation Online

ForgeRock publishes comprehensive documentation online:

  • The ForgeRock Knowledge Base offers a large and increasing number of up-to-date, practical articles that help you deploy and manage ForgeRock software.

    While many articles are visible to community members, ForgeRock customers have access to much more, including advanced information for customers using ForgeRock software in a mission-critical capacity.

  • ForgeRock product documentation, such as this document, aims to be technically accurate and complete with respect to the software documented. It is visible to everyone and covers all product features and examples of how to use them.

A.2. Using the Site

The site has links to source code for ForgeRock open source software, as well as links to the ForgeRock forums and technical blogs.

If you are a ForgeRock customer, raise a support ticket instead of using the forums. ForgeRock support professionals will get in touch to help you.

A.3. How to Report Problems or Provide Feedback

If you have found issues or reproducible bugs within ForgeRock Service Broker 2, report them in

When requesting help with a problem, include the following information:

  • Description of the problem, including when the problem occurs and its impact on your operation

  • Description of the environment, including the following information:

    • Machine type

    • Operating system and version

    • Web server or container and version

    • Java version

    • OpenAM version

    • Any patches or other software that might be affecting the problem

  • Steps to reproduce the problem

  • Any relevant access and error logs, stack traces, or core dumps

A.4. Getting Support and Contacting ForgeRock

ForgeRock provides support services, professional services, classes through ForgeRock University, and partner services to assist you in setting up and maintaining your deployments. For a general overview of these services, see

ForgeRock has staff members around the globe who support our international customers and partners. For details, visit, or send an email to ForgeRock at

Read a different version of :