Older versionVersion 2.7 SolutionsHow to add Reports module to MFA Admin

How to add Reports module to MFA Admin

This document describes how to add the Reports module to MFA Admin.

The reader of this document should have some basic knowledge about PhenixID Server.

System requirements

  • PhenixID Server installed.

Overview

After installation of PhenixID Server the module Reports is part of the Configuration Manager web application.

This document will describe how to add this module to MFA Admin.

We will make changes to the configuration file phenix-store.json, so please make sure to have a backup  of this file.

Instruction

Login to the configuration portal and go to the tab "Advanced".
Now click on the pen next to "Modules" and add the following configuration:

{
		"name": "com.phenixidentity~phenix-prism-report",
		"enabled": "true",
		"config": {
			"display_name": "Reports",
			"base_uri": "report",
			"requires_role": "will be added later in the document"
		},
		"id": "reportsmfaadmin"
	}

Change the display_name and id according to your requirments.

Now find the module:
com.phenixidentity~phenix-prism, with the base_url /mfaadmin.
Like this example:

{
		"name": "com.phenixidentity~phenix-prism",
		"enabled": "true",
		"config": {
			"base_url": "/mfaadmin",
			"auth_redirect_url": "/mfaadmin/authenticate/9159b14e-55ab-4947-af0a-a2538b1ae06d",

In this section add the id for Reports  (reportsmfaadmin in the example above) to module_refs, like this:

"module_refs": "reportsmfaadmin,2fb3b0db-0c5c-4cbc-9215-c12545ca96ea,174ea682-45da-44e6-ad9c-3ba5523c0362"

Last step is to add the role to the reports module. Find the role value on the module:
com.phenixidentity~phenix-prism-otpadmin.

Like this example:

"requires_role": "auth:14f7345f-ac99-4240-9b43-6a810468f53c"

Copy the value to the reports module, so it now looks like this:

{
		"name": "com.phenixidentity~phenix-prism-report",
		"enabled": "true",
		"config": {
			"display_name": "Reports",
			"base_uri": "report",
			"requires_role": "auth:14f7345f-ac99-4240-9b43-6a810468f53c"
		},
		"id": "reportsmfaadmin"
	}

To save the configuration press "Stage changes" and then "Commit changes".

 NOTE: If a custom SSL certificate has been added, or if the module will use a port other than default, the "HTTP_configuration_ref" also needs to be copied from the module:
com.phenixidentity~phenix-prism-otpadmin.

Like this example:

{
"name": "com.phenixidentity~phenix-prism",
"enabled": "true",
"config": {
"base_url": "/mfaadmin",
"auth_redirect_url": "/mfaadmin/authenticate/55dd23aa-f777-4f39-97d1-cdf684167a5f",
"http_configuration_ref": "6a8390b8-27da-4296-ba73-021dcb8d5e75",

So the reports module should then look like this:

{
		"name": "com.phenixidentity~phenix-prism-report",
		"enabled": "true",
		"config": {
			"display_name": "Reports",
			"base_uri": "report",
                        "http_configuration_ref": "6a8390b8-27da-4296-ba73-021dcb8d5e75",
			"requires_role": "auth:14f7345f-ac99-4240-9b43-6a810468f53c"
		},
		"id": "reportsmfaadmin"
	}

Login to MFA Admin and verify the new tab.