# MISP Partner Onboarding

## Overview

This guide shows how Partner Admins can **Onboard a MISP Partner in PMS**. Onboarding includes **Creating a MISP Partner**, **Managing MISP Partner's Partner Certificates**, **Linking a Policy Group**, and **Generating/Managing MISP License Keys** using **PMS portal**.

## What is MISP Partner?

MISP stands for MOSIP Infrastructure Service Provider. It acts as a secure intermediary that facilitates communication between external partners (such as banks, telecoms, or government agencies) and the MOSIP system. The MISP ensures that requests made by these external partners are routed securely and efficiently to the appropriate services within MOSIP, such as the ID Authentication Service.

## Who can 'Onboard a MISP Partner' and What you need to know?

Partner Admins with the appropriate credentials can onboard MISP Partners in PMS. Before starting, ensure CA certificates are uploaded and required policy groups are created.

* You should be logged in with **Partner Admin** credentials (Role: Partner Admin).
* Root and Intermediate CA certificates should have already been uploaded to the PMS **Certificate Trust Store** (these are required before uploading partner CA Signed Certificates).
* Policy Manager should already have created the required **Policy Group** and **MISP policies** (such that they can be selected later). See the Policy Group & MISP Policy creation docs- [Policy Manager](https://github.com/mosip/documentation/blob/1.2.0/docs/id-lifecycle-management/support-systems/partner-management-services/functional-overview/policy-manager/README.md#policies)

## Interface Overview

You (As a Partner Admin) can log into the PMS portal using your credentials. After login, you see the dashboard or left navigation panel, where you click the Partners card to access the 'List of Partners' tabular view.

1. Log into the PMS portal with your Partner Admin account.
2. Click on **Partners** card (from the left navigation panel or dashboard itself). You will be redirected to 'List of Partners' page (tabular view).

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-f365dcb341a372075bfd5ea5a162f062d2ed5349%2Fmisp-image1.png?alt=media)

## Onboarding MISP Partners

Onboarding includes following:

* **Creating a MISP Partner**
* **Managing MISP Partner's Partner Certificates**
* **Linking a Policy Group**, and
* **Generating/Managing MISP License Keys**

### Create a MISP Partner

1. Go to Dashboard > MISP Partner, A 'List View' appears which shows all the partners.
2. Click **Create Partner** button placed on top-right (if partner records already exist) or positioned at the centre of the screen (if no records exist).

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-1865dd930d99c11296566d82d21dd727f5486ce1%2Fmisp-image2.png?alt=media)

2. Enter details in the **Create Partner** form:
   * Partner Type as MISP is already pre-selected.
   * Enter Address, Organization Name, Email Address, and other mandatory fields. Selecting a Policy Group is optional but highly recommended before proceeding.

> Note: Ensure that the Organization name matches the one in the 'CA Signed Certificate' that will be uploaded later.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-00316270f8113ba05c0132f8801e799cfd824af1%2Fmisp-image3.png?alt=media)

3. Click **Save/Submit**. A confirmation message appears on successful creation.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-b2859402435d2edc4c9e1c0ed6d9260cb91c1075%2Fmisp-image4.png?alt=media)

> Note: On the 'Success/Confirmation' screen itself, you are provided with an option to upload CA-Signed partner certificate or return to 'Home page'.

4. Click **Upload Certificate** to proceed with uploading the 'CA Signed Partner Certificate'.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-970e25dd33785636051fc0803213cc9c42c95dd5%2Fmisp-image5.png?alt=media" alt="" data-size="original">

### Upload 'CA Signed Partner Certificate' (First time upload)

Either you can upload the partner certificate right after MISP partner creation as explained in [Create a MISP Partner](#create-a-misp-partner) or you can do it later from the 'List of Partners' page.

1. Go to Dashboard > MISP Partner, A 'List View' appears which shows all the partners.
2. Locate the newly created MISP Partner(inactive status) and choose **Upload Certificate** from the action menu, The **Upload Partner Certificate** popup opens.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-657c129dd3d3fdc3943c271fdc7db0bdbd5c66ca%2Fmisp-image6.png?alt=media)

3. Click the upload area and select the 'CA Signed Certificate' file from local folder in `.cer` or `.pem` format.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-da9a02cfa4a17327442cd8858d21f62fdcb58228%2Fmisp-image7.png?alt=media" alt="" data-size="original">

4. Verify the certificate details auto-populated (Issuer, Validity, etc.) and click **Submit**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-68c424e163646e3c9ef86956697a81d2a04a238e%2Fmisp-image8.png?alt=media" alt="" data-size="original">

5. On success, you (admin) receives a confirmation and the partner row should show the certificate upload date/status along with status as 'ACTIVE'.

   ![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-e306e924c5e6d6ee90198471192da91057843c64%2Fmisp-image9.png?alt=media)

> **Note**:

* If Root/Intermediate CA is missing, the system will reject the upload. Therefore ensure that the CA certificates are uploaded first. [Certificate Trust Store](https://github.com/mosip/documentation/blob/1.2.0/docs/id-lifecycle-management/support-systems/partner-management-services/functional-overview/partner-administration/README.md#certificate-trust-store)

### Re-Upload Partner Certificate (Replacing an existing certificate)

You can replace an existing partner certificate when it is expiring or has been re-issued. This ensures the partner remains compliant and can continue to use PMS services without interruption.

1. Go to Dashboard > Partners, A 'List View' appears which shows all the partners.
2. From Partners table action menu, select **Re-Upload Certificate**.
3. Follow the same upload flow as in [Upload 'CA Signed Partner Certificate' (First time upload)](#upload-ca-signed-partner-certificate-first-time-upload) and click **Submit**.
4. The new certificate details and updated certificate status is displayed in the Partners list.

### Select Policy Group (one-time assignment)

Assign a Policy Group to the MISP Partner, Selecting a policy group ensures the MISP Partner receives the correct permissions, access controls, and features tailored to their needs. It helps enforce organizational policies and simplifies license management.

> Note: Recommended before generating license keys.

1. Go to Dashboard > Partners, A 'List View' appears which shows all the partners.
2. Choose **Select Policy Group** from the Partners action menu, (if it wasn't set during creation).

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-f89cbaead64430860cd86270fd76323c8b189d60%2Fmisp-image10.png?alt=media" alt="" data-size="original">

3. The popup lists available Policy Groups; pick the appropriate one for the partner.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-dd1b4ba034ece939392f43103fbcc4b361e0068c%2Fmisp-image11.png?alt=media" alt="" data-size="original">

4. Click **Submit**

> Note:

* You (Admin) will not be able to modify the policy group selection after submit.
* Selecting a policy group and policy is optional but strongly recommended prior to license key generation.

### Partner Policy Linking (requesting and approving MISP policies)

1. Go to **Partner Policy Linking** (dashboard card or left menu).

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-8f36ca866d0ae1b94e79ead6a23e04b0a44ca031%2Fmisp-image12.png?alt=media)

2. Click on 'Request Policy' button to request for a relevant policy within an already selected 'Policy Group' against the MISP partner ID.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-18693643496174c8d66589ac33f62b1243b2b015%2Fmisp-image13.png?alt=media) ![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-4ac774b6cc459af21e42db8d0c07883640d18ee5%2Fmisp-image14.png?alt=media)

3. Approve the requests after requesting policy, by navigating to the 'Pending Approvals' tab and selecting 'Approve' from the action menu against each request. (View details to inspect the mapping and comments before acting).

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-61809c7338629459aeb2c6b5046dd475ff82f63e%2Fmisp-image15.png?alt=media)

**Success check:** Approved partner-policy links will appear in the partner's policy list.

### MISP Services

The **MISP Services** section in PMS allows Partner Admins to manage license keys for MISP Partners. This includes generating new license keys, viewing and filtering existing keys, regenerating keys when needed, and deactivating keys or partners. These actions ensure secure access and compliance for MISP Partners within the MOSIP Identity System.

#### Generate MISP License Key

You can generate the MISP License Key for a selected policy and partner. The license key is used by the MISP Partner to authenticate and access MOSIP Identity System services as per the linked policy.

1. Go to the **MISP Services** card (from dashboard) or navigate to **MISP Services → Generate MISP License Key**.

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-981888c2ac07742b4c37e22b9fb48333e2f144a2%2Fmisp-image16.png?alt=media) ![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-2b841507b10f304d3fd6bdba826e11d52eec417c%2Fmisp-image17.png?alt=media)

2. On the **Generate MISP License Key** page:
   * Select **Partner ID** (Dropdown shows only MISP partners with uploaded certificates).
   * Policy Group auto-populates (based on Partner ID).
   * Choose **Policy Name** (only approved & active policies show).
   * Enter **MISP License Key Name** (Unique, 1--128 chars).

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-cd42eb3f189b610c3ef33b9c8b413c85cccf4a88%2Fmisp-image18.png?alt=media" alt="" data-size="original">

3. Click **Submit**. A popup displays the newly generated MISP License Key (visible only once).
   * Copy the key (Use **Copy** button). The UI may show "Copied" briefly.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-cb795413bc73f7a4e9969dea3fd6aa491e51bbc9%2Fmisp-image19.png?alt=media" alt="" data-size="original">

4. Close popup → 'Success Message' screen appears. Use **Go Back** to view the list view.

**Important:** The license key value is displayed only once - ensure you copy and store it securely.

### MISP License Keys - List View (list and filters)

You can review, sort, filter, and act on existing license keys.

1. Go to **MISP Services → List View**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-2a1b1756b4184e48eb6a6a53507da368ba2b0b35%2Fmisp-image20.png?alt=media" alt="" data-size="original">

2. Use **Filters** (Partner ID, Policy Group, Policy Name, Name, Status) to narrow results; **Reset Filter** clears filters.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-c1474f7bfbe9711e7e5b9750dfdfcb232c2470a7%2Fmisp-image21.png?alt=media" alt="" data-size="original">

![](https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-e8e577cd8d7186cabd0d0d5d701af7463bfaa52d%2Fmisp-image22.png?alt=media)

3. Columns include: Partner ID, Policy Group, Policy Name, License Key Name, Created Date, Status and Action
4. Click a row or **View** in the action menu to see details. (Deactivated records appear greyed out.)

### Regenerate MISP License Key

You can create a new license key in place of an existing one.

1. Go to **MISP Services → List View**, From the tabular view select the target license key and choose **Regenerate**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-985c349ff17e1e1d1687bd0d9fcc2be56a2c590f%2Fmisp-image23.png?alt=media" alt="" data-size="original">

2. A regeneration form opens with read-only fields and editable **Name** and **Validity**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-f6628856d4337ba41afd9d502b3148b739a07b58%2Fmisp-image24.png?alt=media" alt="" data-size="original">

3. Submit → popup shows the new key (visible only once). Copy and store securely.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-cd0f2166289ec6059ccfd4090dc16d8536fad5e8%2Fmisp-image25.png?alt=media" alt="" data-size="original">

### Deactivate License Key

You can deactivate an active license key such that it can no longer be used for authentication.

1. Go to **MISP Services → List View**, From the tabular view select the target license key and choose **Deactivate**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-ca9d77ae609d6349b80211c01979777f1fccb0f7%2Fmisp-image26.png?alt=media" alt="" data-size="original">

2. Confirm the deactivation on the popup.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-c68a525347d183037ec33e7ac89c47e1b61ec029%2Fmisp-image27.png?alt=media" alt="" data-size="original">

3. On success, the row becomes **Deactivated** and is greyed out; only **View** remains in the action menu.

### Deactivate Partner

You can deactivate the entire MISP Partner (prevents future requests & license generation).

1. Go to **Partners**. From Partners list, open the action menu → **Deactivate Partner**.

> <img src="https://1836199994-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4EyCrLbFom7vj7UcMIUZ%2Fuploads%2Fgit-blob-d4b7e9ee6fae8d6c4d6269a975121d1048342677%2Fmisp-image28.png?alt=media" alt="" data-size="original">

2. Confirm and note the consequences (partner cannot request policies or generate license keys).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mosip.io/1.2.0/id-lifecycle-management/support-systems/partner-management-services/functional-overview/misp-partner-onboarding.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
