Tutorial: Installing the IBM secure authentication module

You can log in to your CMS Portal account by using only the provided email address without directly selecting an authentication registry.

Before you begin

Attention: You must have administrator access to the CMS Portal to complete this task.

Download the IBM Secure Authentication folder.

scrapped secure_auth folder

Perform the following steps:

  1. Clone the custom module. Here is an example if you are using Mac or Linux:
    git clone https://github.com/ibm-apiconnect/cmsportal-addons
  2. Navigate to the ibm_apic_secure_auth folder:
    cd cmsportal-addons/apic_v12/modules/ibm_apic_secure_auth

About this task

In this tutorial, you install a custom module in the CMS Portal to provide an authentication based on email without a user registry selection. For more information, see Custom module development: background and prerequisites.

Procedure

To install the custom module in the CMS Portal:

  1. Create a compressed archive of the custom module by using the following command: 
    tar -czf ibm_apic_secure_auth.tar.gz ibm_apic_secure_auth/
  2. Log in to your CMS Portal site as an administrator.
  3. Click Extend > + Add new module.
  4. In the Add from a URL field, enter a path to the module.

    Alternatively, upload the module in the Upload a module or theme archive section.

  5. Click Continue.
  6. To enable the module, complete the following steps:
    1. Click Extend and search for the custom module that is installed.
      For example, IBM secure authentication.
    2. Select the checkbox next to the module name and click Enable.

Results

You have installed IBM Secure Authentication module in the CMS Portal and enabled it. No further action or configuration is required.