Signet
GitHubCommunityWhat's New
  • eSignet
  • Overview
    • Features
      • Signup Portal
    • Principles
    • Standards & Security
    • License
  • Develop
    • Technology
      • Technology Stack
      • Components - eSignet
      • Components - Signup Portal
      • API
    • Configure eSignet
      • ACR
      • Claims
      • .well-known
        • jwks.json
        • oauth-configuration
        • openid-configuration
  • Test
    • Try It Out
      • Using Mock Data
      • Register Yourself
      • Integrate with eSignet
    • End User Guide
      • Health Portal
        • Login with Biometrics
        • Login with Password
        • Login with OTP
        • Login with QR code (Inji)
        • Knowledge Based Identification
        • Signup and Login with OTP for Verified Claims
    • Integration Guides - eSignet
      • Authenticator Plugin
      • Key Binder Plugin
      • Audit Plugin
      • Digital Wallet
        • Credential Holder
        • Wallet Authenticator
      • Relying Party
    • Integration Guide
      • Identity Verifier Plugin
      • Profile Registry Plugin
      • Integration with eSignet portal
  • Deploy
    • Deployment Architecture
      • On-Prem Installation Guidelines
    • Local Deployment
      • Mock Identity System
      • Mock Relying Party
  • Interoperability
    • MOSIP
    • Inji
    • OpenCRVS
  • Roadmap and Releases
    • Roadmap
      • Roadmap 2025
      • Roadmap 2024
    • Releases
      • v1.6.0
      • v1.5.1
        • Test Report
      • v1.5.0
        • Test Report
      • v1.4.2
      • v1.4.1
        • Test Report
      • v1.4.0
        • Test Report
      • v1.3.0
        • Test Report
      • v1.2.0
        • Test Report
      • v1.1.0
        • Test Report
      • v1.0.0
        • Test Report
      • v0.9.0
        • Test Report
  • Community
    • Code Contribution
    • Code of Conduct
  • General
    • Resources
    • FAQs
    • Glossary
Powered by GitBook

Copyright © 2021 MOSIP. This work is licensed under a Creative Commons Attribution (CC-BY-4.0) International License unless otherwise noted.

On this page
  • Why Purpose-Based Rendering?
  • How It Works
  • Example OIDC Request Payload
  • Summary

Was this helpful?

Edit on GitHub
Export as PDF
  1. Develop
  2. Configure eSignet

Purpose-Based UI Rendering in eSignet

eSignet now supports dynamic UI rendering based on the purpose defined by the relying party (client) during client registration. This enhancement ensures that the user experience is tailored and context-aware across different workflows such as Login, Verify, or Link.

Why Purpose-Based Rendering?

Different service interactions require different messaging and UI contexts. For instance:

  • Login: Accessing a service using verified credentials.

  • Verify: Authenticating user identity to validate a claim.

  • Link: Associating a digital ID with another identity or account.

With this feature, eSignet dynamically adjusts the UI text and flow based on the configured purpose, providing users with a more intuitive and relevant experience.

How It Works

During client registration, the relying party defines the intended purpose for the authentication request. Based on this configuration, eSignet dynamically renders the login interface accordingly.

Configuration Parameters

Parameter
Type
Description

purpose.type

String

Defines the purpose of the UI rendering. Acceptable values: verify, login, link, none

purpose.title

Object

(Optional) Custom title text displayed on the UI. Supports internationalization.

purpose.subTitle

Object

(Optional) Custom subtitle text shown below the title. Supports internationalization.


Valid Values for purpose.type

  • login – Default login interface

  • verify – Verification flow (e.g., claim validation)

  • link – Linking identity or accounts

  • none – No specific UI context; defaults to standard login behavior

Note: If the purpose.type is missing or invalid, the system defaults to login behavior.

Internationalization Support

The title and subTitle fields support language-specific values using locale keys. For example:

"purpose": {
  "type": "login",
  "title": { "eng": "Login using eSignet", "@none": "" },
  "subTitle": { "eng": "Please choose the login option", "@none": "" }
}

Example OIDC Request Payload

"purpose": {
  "type": "verify",
  "title": {
    "eng": "Verify your identity",
    "@none": ""
  },
  "subTitle": {
    "eng": "Authenticate using your preferred method",
    "@none": ""
  }
}

Summary

With purpose-based UI rendering, eSignet enables:

  • A personalized user experience for different authentication flows

  • Clear context provided via customizable titles and subtitles

  • Seamless integration using OIDC request payloads

This feature is especially valuable for deployments with multiple service touchpoints that require tailored messaging across workflows.

Last updated 8 days ago

Was this helpful?