How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I import Service configurations in AM (All versions) using Amster when there are custom modules?

Last updated Jan 18, 2023

The purpose of this article is to provide information on importing Service configurations in AM using Amster when you have custom authentication modules. You must install and register the custom module before you can import a service configuration.


Overview

This article assumes you have working AM and Amster installations, and you have already created a custom authentication module. See The sample custom authentication module for further information on creating custom modules.

Prior to importing service configurations that contain custom authentication modules, you must install and register the custom module as explained in this article.

Import Error

Failing to install and register the custom module first will cause the import to fail with the following error (where custom-authentication-module is the example custom module name):

Failed to import /path/to/config/global/custom-authentication-module.json : Unrecognised entity type: custom-authentication-module Failed to import /path/to/config/realms/realmName/custom-authentication-module/custom-authentication-module.json : Unrecognised entity type: custom-authentication-module

Importing service configurations that contain custom modules

You can import service configurations that contain custom authentication modules as follows:

  1. Copy the custom authentication module jar file to the /path/to/tomcat/webapps/am/WEB-INF/lib directory, for example: $ cp custom-authentication-module-5.5.0.jar /path/to/tomcat/webapps/am/WEB-INF/lib
  2. Restart the web application container in which AM runs to complete the registration of the custom module.
  3. You can now import your service configurations using the Amster import-config command, for example: am> import-config --path /path/to/config

See Also

How do I export and import Service configurations for AM (All versions) using Amster or ssoadm?

How do I customize authentication modules using source code in AM (All versions)?

How do I access and build the sample code provided for AM (All versions)?

The sample custom authentication module

Import configuration data

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2023 ForgeRock, all rights reserved.