Partner Self Service Portal
1. Partner Management
A. Create a Partner
Upon receiving a request to create a partner with input parameters (Partner ID, Partner Organization Name, Partner Contact Number, Partner Email ID, Partner Address, IsActive), the system stores the data in the database.
Throws an error message if mandatory parameters are missing.
B. Read Partner
Upon receiving a request to fetch a Partner with input parameters (Partner ID and/or Partner Organization Name), the system fetches the data existing against the input parameter received.
If only Partner ID is received, fetches data against the Partner ID from the database
If Partner Organization Name is received, fetches data against the Partner Organization Name from the DB
If both Partner ID and Partner Organization Name are received, fetches data against the combination of both the input parameters
If the input parameter received is null or empty, fetches all the data
Fetches only active data from the database
If the data does not exist for input parameters received, throw the appropriate message.
In case of exceptions, the system should trigger relevant error messages.
C. Update Partner
Upon receiving a request to update a Partner with input parameters (Partner ID, Partner Organization Name, Partner Contact Number, Partner Email ID, Partner Address, IsActive) the system updates the data as per the below steps:
Partner ID serves as search criteria to update the record in the database
Updates the data received against the data already existing in the database against the Partner ID received
If the mandatory input parameters are missing, throws the appropriate message.
In case of exceptions, the system triggers relevant error messages.
D. Deactivate Partner
Upon receiving a request to deactivate a Partner with input parameters (Partner ID), the system deactivates the data as requested
Responds to the source with the required message
If the mandatory input parameters are missing, throw the appropriate message
In case of exceptions, the system triggers relevant error messages
2 Policies Management
A. Create a Policy
Upon receiving a request to create a Policy with input parameters (Policy ID, Policy Name, Policy Description, Policy Json File, IsActive), the system stores the data in the database and responds to the source with the required message
If the mandatory input parameters are missing, throw the appropriate message
In case of exceptions, the system should trigger relevant error messages
B. Read Policy
The system receives a request to fetch a Policy with input parameters (Policy ID and/or Policy Name)
Fetches the data existing against the input parameter received
Responds to the source with the required data
If only Policy ID is received, fetches data against the Policy ID from the database
If Policy Name is received, fetches data against the Policy Name from the database
If both Policy ID and Policy Name are received, fetches data against the combination of both the input parameters
If the input parameter received is null or empty, fetches all the data
Fetches only active data from the database
If the data does not exist for input parameters received, throw the appropriate message.
In case of exceptions, the system triggers relevant error messages
C. Update Policy
Upon receiving a request to update a Policy with input parameters (Policy ID, Policy Name, Policy Description, Policy Json File, IsActive), the system updates the data and responds to the source with the required message
Policy ID serves as search criteria to update the record in the database
Updates the data received against the data already existing in the database against the Policy ID received
If the mandatory input parameters are missing, throws the appropriate message
In case of exceptions, the system triggers relevant error messages
D. Delete Policy
Upon receiving a request to delete a Policy with input parameters (Policy ID) the system deletes the data as requested and responds to the source with the required message
If the mandatory input parameters are missing, throws the appropriate message
In case of exceptions, the system triggers relevant error messages.
3 Partner Policy Mapping
A. Create Partner-Policy Mapping
Upon receiving a request to create a Partner-Policy Mapping with input parameters (Partner ID, Policy ID, IsActive), the system stores the data in the database and responds to the source with the required message:
Input parameters must be present as mentioned below:
Partner ID - Mandatory
Policy ID - Mandatory
IsActive - Mandatory
There can only be one Policy mapped to a Partner
If the mandatory input parameters are missing, the system throws the appropriate message
In case of exceptions, the system triggers relevant error messages.
B. Read Policy Json File based on Partner ID
Upon receiving a request to fetch a Policy with input parameters (Partner ID), the system fetches the data existing against the input parameter received and responds to the source with the required data as per the below steps:
Fetches the Policy mapped to the Partner ID received in the input
Fetches only active data from the database
If the mandatory input parameters are missing, throws the appropriate message.
If the data does not exist for input parameters received, throw the appropriate message
In case of exceptions, the system triggers relevant error messages.
C. Update Partner-Policy Mapping
Upon receiving a request to update a Partner-Policy Mapping with input parameters (Partner ID, Policy ID, IsActive), the system updates the data and responds to the source with the required message as per the below steps:
Input parameters must be present as mentioned below:
Partner ID - Mandatory
Policy ID - Mandatory
IsActive - Mandatory
Partner ID serves as search criteria to update the record in the database
There can only be one Policy mapped to a Partner
Updates the data received against the data already existing in the database against the Partner ID received
If the mandatory input parameters are missing, throw the appropriate message
In case of exceptions, the system triggers relevant error messages.
D. Delete Partner-Policy Mapping
Upon receiving a request to delete a Partner-Policy Mapping with input parameters (Partner ID, Policy ID), the system deletes the data as requested and Responds to the source with the required message
Input parameters must be present as mentioned below:
Partner ID - Mandatory
Policy ID - Mandatory
If the mandatory input parameters are missing, throw the appropriate message
In case of exceptions, the system triggers relevant error messages.
4 Generate API Key
An Authentication partner can generate an API key for a policy which is mapped with the partner.
6 MISP License Key Generation
Once a MISP partner is active it can generate a license key that can be shared with Relying Parties for authentication.
7 Validate and Re-issue Digital Certificate to Partner
Upon receiving a request to validate the Digital Certificate provided by a Partner with Input (Digital Certificate), the system does the following:
Validates the Digital Certificate
Signs the Digital Certificate with MOSIP's Certificate and issue a Certificate Chain
Responds with the signed certificate to the source
If the mandatory input parameters are missing, throws the appropriate message.
In case of exceptions, the system triggers relevant error messages
8 Distribution of Public Keys to Partners
Upon receiving a request to get Public Key with an input parameter (Date Time-stamp) the system performs the following steps:
The system calls the Key Manager Service to get the Public Key with Input Parameter (Application ID, Reference ID, Date Time-Stamp)
Retrieves the Public Key as per the timestamp.
Responds to the source with the Private Key
The Public Key should be a valid and active key for the time-Stamp received
The Public Key corresponds to the Private Key used by the IDA
If the mandatory input parameters are missing, the system throws the appropriate message.
In case of exceptions, the system triggers relevant error messages.
Last updated