MOSIP Docs 1.1.5
GitHubCommunityTech Blogs
  • Home
  • Architecture
    • Guiding Principles
    • MOSIP Architecture
      • Technology Stack
    • MOSIP and Data
      • Naming Standards
      • Data-Model
    • Privacy & Security
      • Cryptography in MOSIP
    • Anonymous Profiling Support
  • Modules
    • Pre-Registration
      • Pre-Registration Functionality
      • UI Specification for Pre-registration
      • Pre-Registration Configuration
    • Registration
      • Registration Functionality
      • Registration Packet
      • Registration Client Setup
      • First User Registration and Onboarding
      • Guide to Configure MOSIP for Biometrics
      • Guide to On-board Biometric Devices
      • Device Integration Specifications
      • UI Specification for Registration Client
    • Registration Processor
      • Registration Processor Functionality
      • Deduplication and Manual Adjudication
      • MOSIP ID Object Definition
    • ID Repository
    • ID Authentication
      • ID Authentication Functionality
    • Resident Services
      • Resident Services Functionality
    • Partner Management
      • Partner Management Functionality
      • MOSIP Partner Secure Communication
      • Partner Self Service Portal
    • Administration
      • Admin Services Functionality
      • Download Card
    • Kernel
      • Audit Manager Functionality
        • Admin Service Audits
        • Resident Service Audits
        • Partner Management Audits
        • Registration Client Audits
        • Registration Processor Audits
        • ID Repository Audits
        • ID Authentication Audits
        • Pre-registration Audits
      • Authentication and Authorization Functionality
      • Auth Adapter
      • Auth Implementation
      • Common Services Functionality
      • Data Services Functionality
      • Master Data Services Functionality
      • UIN and VID Generation Service Functionality
      • VID Generator
  • Biometrics
    • ABIS
    • Biometric SDK
    • MDS Specification
    • Biometric Specification
    • CBEFF XML
    • Compliance Tool Kit
  • Build & Deploy
    • Sandbox Installer
    • Deployment Architectures
    • Cell Based Deployment Architecture
    • Hardware Security Module HSM Specifications
    • Hardware Sizing
    • Customizations for a Country
    • Other Installation Guides
      • Steps to Install and Configure HDFS
      • Steps to Install and use PostgreSQL Version 10.2 on RHEL 7.5
      • Steps to Install Clam AntiVirus Version 0.101.0
      • Steps to Install Keycloak Standalone Server
    • Services in MOSIP
  • Glossary
  • Contribute
    • Call for Contribution
    • Contributor's Guide
    • Code of Conduct
    • Issue Reporting Guideline
    • Coding Standards
      • Auth Angular User Guide
      • Auth SpringBoot User Guide
      • Gitub Workflow
      • MOSIP Java Coding Standards
      • MOSIP REST API guidelines
      • Registration Client UI Developer Document
      • Registration Client Developer Documentation
      • Security Tools
    • Testing
      • Test Rig Design
      • Tester Documentation
      • Testing Attachments Kernel
  • APIs
    • ABIS APIs
    • Admin APIs
    • AuthN and AuthZ APIs
    • Biometric SDK APIs
    • BlacklistedWords APIs
    • Common APIs
    • Device APIs
    • Device Type and Subtype APIs
    • Device Management APIs
    • Document APIs
    • Dynamic Fields APIs
    • Holiday APIs
    • ID Authentication APIs
    • ID Repository APIs
    • ID Schema APIs
    • Kernel APIs
    • Machine APIs
    • Master Data Biometric APIs
    • Packet APIs
    • Packet Manager APIs
    • Partner Management Service APIs
    • Pre Registration APIs
    • Registration Center APIs
    • Registration Processor APIs
    • Resident Service APIs
    • Sync Data APIs
    • Template APIs
    • Zone APIs
  • Older Releases
    • Release Notes 1.1.5
      • Enhancements
      • Defect Fixes
      • Patches
        • Patch 1.1.5.5
        • Patch 1.1.5.5-P1
    • Release Notes 1.1.4
      • Enhancements
      • Defect Fixes
    • Release Notes 1.1.3
      • Features
      • Bug Fixes
    • Release Notes 1.1.2
      • Features
      • Bug Fixes
    • Release Notes 1.1.1
      • Bug Fixes
      • Artifact Version
    • Release Notes 1.1.0
      • Features
      • Bug Fixes
      • 1.2.0 Features
      • Artifact Version
    • Release Notes 1.0.6
    • Release Notes 1.0.5
    • Release Notes 1.0.0
      • Features
    • Release Notes 0.9.0
  • Roadmap
    • Roadmap Activities
  • Revision History
  • License
Powered by GitBook
On this page
  • 1. Partner Management
  • A. Create a Partner
  • B. Read Partner
  • C. Update Partner
  • D. Deactivate Partner
  • 2 Policies Management
  • A. Create a Policy
  • B. Read Policy
  • C. Update Policy
  • D. Delete Policy
  • 3 Partner Policy Mapping
  • A. Create Partner-Policy Mapping
  • B. Read Policy Json File based on Partner ID
  • C. Update Partner-Policy Mapping
  • D. Delete Partner-Policy Mapping
  • 4 Generate API Key
  • 6 MISP License Key Generation
  • 7 Validate and Re-issue Digital Certificate to Partner
  • 8 Distribution of Public Keys to Partners

Was this helpful?

Export as PDF
  1. Modules
  2. Partner Management

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.

  1. If only Partner ID is received, fetches data against the Partner ID from the database

  2. If Partner Organization Name is received, fetches data against the Partner Organization Name from the DB

  3. If both Partner ID and Partner Organization Name are received, fetches data against the combination of both the input parameters

  4. If the input parameter received is null or empty, fetches all the data

  5. Fetches only active data from the database

  6. If the data does not exist for input parameters received, throw the appropriate message.

  7. 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:

  1. Partner ID serves as search criteria to update the record in the database

  2. Updates the data received against the data already existing in the database against the Partner ID received

  3. If the mandatory input parameters are missing, throws the appropriate message.

  4. 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

  1. Responds to the source with the required message

  2. If the mandatory input parameters are missing, throw the appropriate message

  3. 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

  1. If the mandatory input parameters are missing, throw the appropriate message

  2. In case of exceptions, the system should trigger relevant error messages

B. Read Policy

  1. The system receives a request to fetch a Policy with input parameters (Policy ID and/or Policy Name)

  2. Fetches the data existing against the input parameter received

  3. 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.

  4. 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

  1. Policy ID serves as search criteria to update the record in the database

  2. Updates the data received against the data already existing in the database against the Policy ID received

  3. If the mandatory input parameters are missing, throws the appropriate message

  4. 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

  1. If the mandatory input parameters are missing, throws the appropriate message

  2. 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:

  1. Input parameters must be present as mentioned below:

    • Partner ID - Mandatory

    • Policy ID - Mandatory

    • IsActive - Mandatory

  2. There can only be one Policy mapped to a Partner

  3. If the mandatory input parameters are missing, the system throws the appropriate message

  4. 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:

  1. Fetches the Policy mapped to the Partner ID received in the input

  2. Fetches only active data from the database

  3. If the mandatory input parameters are missing, throws the appropriate message.

  4. If the data does not exist for input parameters received, throw the appropriate message

  5. 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:

  1. Input parameters must be present as mentioned below:

    • Partner ID - Mandatory

    • Policy ID - Mandatory

    • IsActive - Mandatory

  2. Partner ID serves as search criteria to update the record in the database

  3. There can only be one Policy mapped to a Partner

  4. Updates the data received against the data already existing in the database against the Partner ID received

  5. If the mandatory input parameters are missing, throw the appropriate message

  6. 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

  1. Input parameters must be present as mentioned below:

    • Partner ID - Mandatory

    • Policy ID - Mandatory

  2. If the mandatory input parameters are missing, throw the appropriate message

  3. 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:

  1. Validates the Digital Certificate

  2. Signs the Digital Certificate with MOSIP's Certificate and issue a Certificate Chain

  3. Responds with the signed certificate to the source

  4. If the mandatory input parameters are missing, throws the appropriate message.

  5. 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:

  1. The system calls the Key Manager Service to get the Public Key with Input Parameter (Application ID, Reference ID, Date Time-Stamp)

  2. Retrieves the Public Key as per the timestamp.

  3. Responds to the source with the Private Key

  4. The Public Key should be a valid and active key for the time-Stamp received

  5. The Public Key corresponds to the Private Key used by the IDA

  6. If the mandatory input parameters are missing, the system throws the appropriate message.

  7. In case of exceptions, the system triggers relevant error messages.

PreviousMOSIP Partner Secure CommunicationNextAdministration

Last updated 1 year ago

Was this helpful?