LogoLogo
1.1
1.1
  • ๐Ÿ Overview
  • ๐ŸขArchitecture
  • ๐Ÿ“‹Registration
    • Registration Interfaces
      • ODK Collect App
      • Self Service Portal
      • API Interface
      • Manual Entry
      • Bulk Export From CSV
    • ID Verification
    • Registry
  • ๐Ÿ…ฟ๏ธProgram Management
    • Eligibility Assessment
    • Proxy Means Test
    • Enrolment
    • Deduplication
    • Program Cycles
    • Entitlement
    • Notifications
  • ๐Ÿ’ตPayments
    • Payment Modes
    • Payment Manager
    • Payment Batches
    • ID Account Mapper
    • Payment Rails
    • Reimbursements
      • Service Provider Portal
  • ๐Ÿ”Privacy & Security
  • ๐Ÿ“ŠMonitoring and Reporting
  • ๐Ÿ”งSystem Administration
    • Developer Mode
    • Role-Based Access Control
    • Internationalization (i18n)
    • Document Store
    • Apps
  • โ›“๏ธWorkflows
    • Cash grant scenario
    • Immediate Individual Assistance On-Demand
    • Service Provider Reimbursement
  • ๐Ÿ”—Integrations
    • M-PESA Integration
    • Mojaloop Integration
    • MOSIP Integration
      • ODK MTS Connector
      • Registry MTS Connector
      • Integration with e-Signet
  • ๐Ÿ“ฆReleases
    • 1.1.0
      • Release Notes
  • โ†”๏ธREST API
  • โš’๏ธTesting
  • ๐Ÿ‘ฅCommunity
    • Contributing
    • Code of Conduct
  • ๐Ÿ“—License
  • Guides
    • ๐Ÿ“”How-To Guides
      • Install WireGuard Client on Desktop/Laptop
      • Install WireGuard Client on Android Device
      • Create User and Assign Role
      • Create a Custom Group
      • Create Program
      • Create Self-Service Portal Form
      • Map Self-Service Portal Form
      • Self Register Online
      • Integrate with MOSIP e-Signet
      • Create ODK Form
      • Provide Form Access to Field Agent
      • Download Form on ODK Collect
      • Register Offline
      • Create MTS Connector
        • Create ODK MTS Connector
        • Create OpenG2P Registry MTS Connector
      • Create Eligibility Manager Types
        • Create Default Eligibility Manager
        • Create ID Document Eligibility Manager
        • Create Phone Number Eligibility Manager
      • Create Eligibility Manager under Program
      • Configure Proxy Means Test
      • Enrol Registrants into Program
      • Configure ID Types
      • Create Deduplication Manager under Program
      • Create Deduplication Manager Types
        • Create ID Deduplication Manager
        • Create Phone Number Deduplication
      • Deduplicate Registrants
      • Create Notification Manager Types
        • Create SMS Notification Manager
        • Create Email Notification Manager
        • Create Fast2SMS Notification Manager
      • Create Notification Manager under Program
      • Send Notifications to Individual Registrants
      • Configure Program Manager under Program
      • Create and Approve Program Cycle
      • Multi-Stage Approval
      • Create Entitlement Voucher Template
      • Create Entitlement Manager Type
        • Create Default Entitlement Manager
        • Create Voucher Entitlement Manager
      • Configure Entitlement Manager under Program
      • Create Payment Manager Types
        • Create Payment Hub EE Payment Manager
        • Create Payment Interoperability Layer Payment Manager
        • Create Default Payment Manager
        • Create Cash Payment Manager
        • Create File Payment Manager
      • Configure Payment Manager in Program
      • Prepare and Send Payment
      • Install SmartScanner App
      • Submit Reimbursement Using the Service Provider Portal
      • Reimburse the service provider
    • ๐Ÿ“™Documentation Guides
      • Creating Diagrams
      • OpenG2P Module Doc Template
      • Writing Guidelines For How-To Guides
    • ๐Ÿ‘ฉโ€๐Ÿ’ปDeveloper Zone
      • Getting Started
      • Installing OpenG2P On Linux
      • Technology Stack
      • Modules
        • G2P Entitlement In-kind
        • G2P SelfServicePortal
        • OpenG2P Program Payment: G2P Connect Payment Manager
        • G2P Notifications: Wiserv SMS Service Provider
        • G2P Registry: Rest API
        • G2P Formio
        • G2P Registry: Base
        • G2P Registry: Individual
        • G2P: Proxy Means Test
    • ๐Ÿ“˜Deployment Guide
      • Deployment on Kubernetes
        • K8s Cluster Requirements
        • K8s Cluster Setup
        • Rancher Server Setup
        • NFS Server Setup
        • SSL Certificates using Letsencrypt
      • Post Install Configuration
      • Access to Deployed Setup
      • Packaging OpenG2P Docker
Powered by GitBook
LogoLogo

Copyright ยฉ OpenG2P. This work is licensed under Creative Common Attribution (CC-BY-4.0) International license unless otherwise noted.

On this page
  1. Guides
  2. How-To Guides

Integrate with MOSIP e-Signet

PreviousSelf Register OnlineNextCreate ODK Form

Last updated 1 year ago

Description

This guide provides steps to integrate as the authentication provider.

Pre-requisites

  1. MOSIP IDA is installed

  2. The e-Signet server is installed and configured to connect to MOSIP IDA

  3. MOSIP IDA APIs are accessible from the machine running the e-Signet server

  4. Both Yes/No and KYC APIs are enabled on MOSIP IDA

  5. e-Signet APIs are accessible from machines running OpenG2P

  6. Biometric auth devices (already onboarded on MOSIP) are available for authentication

  7. Email and SMS are enabled on MOSIP IDA for OTP authentication

  8. MOSIP Partner Management Services (PMS) Portal or APIs must be accessible to both MOSIP Partner Admin and OpenG2P Admin

  9. MOSIP Partner Specific User Token (PSUT) ID type is configured. See .

Steps

Configure OpenG2P as a partner on MOSIP

  1. Create an Auth Partner for OpenG2P on MOSIP.

    • Guide for MOSIP 1.1.5 (TBD)

  2. Create a MISP Partner for OpenG2P on MOSIP.

  3. Note down the following from the above steps:

    1. Auth Partner ID

    2. Auth Policy ID

    3. Auth API Key

    4. MISP License Key

    5. Auth partner signed certificate

    6. IDA Partner certificate (App id: IDA, Ref Id: PARTNER)

Configure OpenG2P as relying party on e-Signet

Using PMS API

This method is applicable if MOSIP Partner Management APIs are available. These steps are executed by MOSIP Partner Admin

  1. Create an e-Signet OIDC client using PMS OIDC API:

  • logoUri: URL of your logo accessible publicly.

  • grantTypes = ["authorization_code"]

  • clientAuthMethods= ["private_key_jwt"]

  • redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin

Note down the Client ID as an output of the above step.

Using e-Signet API

This method is applicable if MOSIP Partner Management APIs are not available.

  1. Create an e-Signet OIDC client using the following API:

  • clientId: Arbitrary string.

  • clientName: Arbitrary string.

  • authContextRefs:

    ["mosip:idp:acr:biometrics","mosip:idp:acr:generated-code"]
  • userClaims:

    ["birthdate","address","gender","name","phone_number","email","picture"]
  • logoUri: URL of your logo accessible publicly.

  • grantTypes = ["authorization_code"]

  • clientAuthMethods= ["private_key_jwt"]

  • redirectUris: URLs of the form https://<your web portal>/auth_oauth/signin

Enable e-Signet on OpenG2P

These steps are executed by OpenG2P Admin on the OpenG2P Admin interface.

  1. Go to Settings -> General Settings (Menu) -> General Settings (Panel) -> Integrations (Section) -> Oauth Providers

  1. Create a new OIDC Provider with the following details:

Parameter
Value

Client ID

Auth Flow

OpenID Connect (authorization code flow)

Token map

sub:user_id

Client Authentication Method

Private Key JWT

Private Key Method

Assertion Type

JWT Bearer

Authorization URL

e-Signet's authorize endpoint.

Userinfo URL

e-Signet's userinfo API

Token URL

e-Signet's token API

JWKS URL

e-Signet's JWKS API

Use G2P Reg ID

True

G2P Registrant ID Type

MOSIP PSUT ID Type

Partner Creation Call Validate URL

True

Specifies whether to call the MOSIP e-KYC API to fetch data into OpenG2P

Partner Creation Validate Response

name:name email:email phone:phone_number birthdate:birthdate gender:gender address:address

Default Group User Creation

User types / Portal

Specifies all users signing up through this OIDC Provider (e-Signet) are only going to be portal users

Login Attribute Mapping On User Creation

email

To allow users to sign in with their email and password after initial signup with e-Signet.

for MOSIP 1.2.0

authParnterId: Partner ID in step.

policyId : Policy ID in step.

publicKey: Generate .

relyingParnterId: Partner ID in step.

publicKey: Generated .

The output of the .

Private key used for JWK creation in the .

Example:

Example:

Example:

Example:

As configured in step 9 of .

๐Ÿ“”
OpenG2P with e-Signet with MOSIP
Configure ID Types
Guide
JWK
JWK
this
this
this
https://esignet.mec.mosip.net/authorize
https://api.mec.mosip.net/v1/esignet/oidc/userinfo
https://api.mec.mosip.net/v1/esignet/oauth/token
https://api.mec.mosip.net/v1/esignet/oauth/.well-known/jwks.json
previous section
previous section
Prerequisites
post
Body
requestTimestringOptional
Responses
200
OK
application/json
post
POST /v1/esignet/client-mgmt/oidc-client HTTP/1.1
Host: api-internal.mec.mosip.net
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "requestTime": "text",
  "request": {
    "clientId": "text",
    "clientName": "text",
    "publicKey": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "relyingPartyId": "text",
    "userClaims": [
      "text"
    ],
    "authContextRefs": [
      "text"
    ],
    "logoUri": "text",
    "redirectUris": [
      "text"
    ],
    "grantTypes": [
      "text"
    ],
    "clientAuthMethods": [
      "text"
    ]
  }
}
200

OK

{
  "responseTime": "text",
  "response": {
    "clientId": "text",
    "status": "text"
  },
  "errors": [
    {
      "errorCode": "text",
      "errorMessage": "text"
    }
  ]
}
  • Description
  • Pre-requisites
  • Steps
  • Configure OpenG2P as a partner on MOSIP
  • Configure OpenG2P as relying party on e-Signet
  • POST/oidc/client
  • POST/client-mgmt/oidc-client
  • Enable e-Signet on OpenG2P
post
Body
idstringOptional
versionstringOptional
requesttimestring ยท date-timeOptional
metadataobjectOptional
Responses
200
OK
application/json
post
POST /v1/partnermanager/oidc/client HTTP/1.1
Host: api-internal.mec.mosip.net
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "id": "text",
  "version": "text",
  "requesttime": "2025-05-16T11:06:51.933Z",
  "metadata": {},
  "request": {
    "name": "text",
    "policyId": "text",
    "publicKey": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "authPartnerId": "text",
    "logoUri": "text",
    "redirectUris": [
      "text"
    ],
    "grantTypes": [
      "text"
    ],
    "clientAuthMethods": [
      "text"
    ]
  }
}
200

OK

{
  "id": "text",
  "version": "text",
  "responsetime": "2025-05-16T11:06:51.933Z",
  "metadata": {},
  "response": {
    "clientId": "text",
    "status": "text"
  },
  "errors": [
    {
      "errorCode": "text",
      "message": "text"
    }
  ]
}